The Mouse object controls the mouse cursor and can simulates the click buttons.
Functions
| CancelCapture | Stops the current capture started with Mouse.Capture, then calls the Mouse.OnCancelCapture event. |
|---|---|
| Capture | Allows to capture the mouse events until the button is released. |
| DoLeftClick | Simulates a left click mouse button. |
| DoLeftDoubleClick | Simulates a left double click mouse button. |
| DoLeftDown | Simulates a left click mouse button. |
| DoLeftUp | Simulates a left click mouse button. |
| DoMiddleClick | Simulates a middle click mouse button. |
| DoMiddleDoubleClick | Simulates a middle double click mouse button. |
| DoMiddleDown | Simulates a middle click mouse button. |
| DoMiddleUp | Simulates a middle click mouse button. |
| DoRightClick | Simulates a right click mouse button. |
| DoRightDoubleClick | Simulates a right double click mouse button. |
| DoRightDown | Simulates a right click mouse button. |
| DoRightUp | Simulates a right click mouse button. |
| Get | Retrieves the position of the mouse cursor in pixels. |
| GetX | Retrieves the horizontal position of the mouse cursor in pixels. |
| GetY | Retrieves the vertical position of the mouse cursor in pixels. |
| IsLeftButton | Tests if the left button is down. |
| IsMiddleButton | Tests if the middle button is down. |
| IsRightButton | Tests if the right button is down. |
| Set | Changes the position of the mouse cursor. |
| ShowCursor | Shows or hides the mouse cursor. |
Events
| OnCancelCapture | Is called after Mouse.Capture when the capture is cancelled with the Mouse.CancelCapture function. |
|---|---|
| OnReleaseCapture | Is called after Mouse.Capture when the button is released. |
| OnUpdateCapture | Is called after Mouse.Capture when the cursor is moving until the button is released. |
Constants
The Mouse object has no constants.