Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

RemoteControl.MouseButtons

Returns bit mask for pressed mouse buttons.

Component Version macOS Windows Linux Server iOS SDK
RemoteControl 11.5 ✅ Yes ✅ Yes ❌ No ❌ No ❌ No
MBS( "RemoteControl.MouseButtons" )

Parameters

none

Result

Returns 1 or error.

Description

Returns bit mask for pressed mouse buttons.
Returns indices of the mouse buttons currently down.
1 corresponds to left mouse button.
2 is for right mouse.
4 is for third button.
8 is for forth button.
16 is for fifth button.
You may get a value like 3 if both left and right mouse buttons are pressed.

If you query this in a script triggered by a button, you may be too late and the mouse already releases. For that case, please use EventMonitor.LastMouseClickButton instead.

Examples

Query mouse buttons:

Set Variable [ $buttons; MBS( "RemoteControl.MouseButtons" ) ]

See also

Release notes

Blog Entries

This function checks for a license.

Created 27th September 2021, last changed 27th September 2021


RemoteControl.IsShiftKeyDown - RemoteControl.MouseX