API Mouse.GetButtons: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the button state from the mouse: 4 for left, 1 for right
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''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===[[API Mouse|Mouse]]
-:[[API 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==