API Mouse.GetButtons

From Flowcode Help
Jump to navigationJump to search

<sidebar>API Contents</sidebar> Gets the button state from the mouse: 4 for left, 1 for right

Class hierarchy

Mouse

GetButtons

Parameters

This function has no parameters


Return value

BYTE

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