API Mouse.GetButtons: Difference between revisions
XML import of updated API docs |
No edit summary |
||
| Line 22: | Line 22: | ||
==Detailed description== | ==Detailed description== | ||
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) | |||
|} | |||
Revision as of 21:07, 2 August 2013
<sidebar>API contents</sidebar>
Gets the button state from the mouse: 4 for left, 1 for right
Parameters
This function has no parameters
Return value
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