Difference between revisions of "API Mouse.GetButtons"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets the button state from the mouse: 4 for left, 1 for right
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetButtons'''
 +
|-
 +
| colspan="2" | Gets the button state from the mouse: 4 for left, 1 for right&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
===Class hierarchy===
 
:Mouse
 
::GetButtons
 
</div>
 
__TOC__
 
  
==Parameters==
+
==Detailed description==
''This function has no parameters''
+
This returns the button state of the mouse. Buttons are assigned as:
 
+
{| class=wikitable
==Return value==
+
|-
[[Variable types|BYTE]]
+
! Bit
 
+
! Meaning
Returns the button state from the mouse: 4 for left, 1 for right
+
|-
 +
|1
 +
|Right mouse button (menu)
 +
|-
 +
|2
 +
|Middle mouse button (wheel)
 +
|-
 +
|4
 +
|Left mouse button (select)
 +
|}
  
==Detailed description==
 
''No additional information''
 
  
 
==Examples==
 
==Examples==

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetButtons
Gets the button state from the mouse: 4 for left, 1 for right 
Fc9-u8-icon.png - BYTE Return


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()