Difference between revisions of "API Mouse.GetButtons"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets the button state from the mouse: 4 for left, 1 for right
 
Gets the button state from the mouse: 4 for left, 1 for right
  
Line 20: Line 20:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
This returns the button state of the mouse. Buttons are assigned as:
 +
{| class=wikitable
 +
|-
 +
! Bit
 +
! Meaning
 +
|-
 +
|1
 +
|Right mouse button (menu)
 +
|-
 +
|2
 +
|Middle mouse button (wheel)
 +
|-
 +
|4
 +
|Left mouse button (select)
 +
|}
  
  
Line 28: Line 42:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetButtons()</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetButtons()</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the button state from the mouse: 4 for left, 1 for right

Class hierarchy

Mouse

GetButtons

Parameters

This function has no parameters


Return value

BYTE

Returns the button state from the mouse: 4 for left, 1 for right


Detailed description

This returns the button state of the mouse. Buttons are assigned as:

Bit Meaning
1 Right mouse button (menu)
2 Middle mouse button (wheel)
4 Left mouse button (select)


Examples

Calling in a calculation

  • Declare a variable 'result' of type BYTE
  • Add to a calculation icon:
    result = ::Mouse.GetButtons()

No additional examples