Desktop.MouseHook¶
Name | Mandatory | Description | Default | Type |
---|---|---|---|---|
⬅️ Input |
The input of this shard is ignored. | None |
||
Output ➡️ |
An Int4 value where: | |||
- First element [0]: State (0 = button down, 1 = button up, -1 = mouse move) | ||||
- Second element [1]: Button (0 = left, 1 = right, 2 = middle, -1 = none/move) | ||||
- Third element [2]: X position | ||||
- Fourth element [3]: Y position | Int4 |
|||
Window |
No | None or a window variable we wish to use as relative origin. | none |
Var(Object) None |
MaxQueueSize |
No | Maximum number of events to queue before dropping old ones. | 100 |
Int |
This shard captures mouse events using a low-level mouse hook and outputs the event as an Int4 value. It waits for mouse events and returns them one at a time.