Difference between revisions of "API Mouse.GetButtons"

Latest revision as of 11:55, 16 January 2023

	GetButtons
Gets the button state from the mouse: 4 for left, 1 for right
- BYTE	Return

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

@@ Line 1: / Line 1: @@
-API contents
+{| 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''
+|}
-===Parameters===
+==Detailed description==
-''This function has no parameters''
+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)
+|}
-===Return value===
-[[Variable types|BYTE]]
-Returns the button state from the mouse: 4 for left, 1 for right
+==Examples==
+===Calling in a calculation===
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type BYTE
-* Add to a calculation icon: result = ::Mouse.GetButtons()
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetButtons()</pre>