Difference between revisions of "API Mouse.GetButtons"

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

This function has no parameters

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

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

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
 Gets the button state from the mouse: 4 for left, 1 for right
+<div style="width:25%; float:right" class="toc">
+====Class hierarchy====
+[[API Mouse|Mouse]]
+:[[API Mouse|GetButtons]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''This function has no parameters''
-===Return value===
-[[Variable types|BYTE]]
+==Return value==
+[[Variable Types|BYTE]]
 Returns the button state from the mouse: 4 for left, 1 for right
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation====
+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)
+|}
+==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>
+''<span style="color:red;">No additional examples</span>''