InputEventMouse¶
Inherits: InputEventWithModifiers < InputEvent < Resource < Reference < Object
Inherited By: InputEventMouseButton, InputEventMouseMotion
Base input event type for mouse events.
Description¶
Stores general mouse events information.
Tutorials¶
Properties¶
| int | button_mask | 0 |
| Vector2 | global_position | Vector2( 0, 0 ) |
| Vector2 | position | Vector2( 0, 0 ) |
Property Descriptions¶
- int button_mask
| Default | 0 |
| Setter | set_button_mask(value) |
| Getter | get_button_mask() |
The mouse button mask identifier, one of or a bitwise combination of the ButtonList button masks.
- Vector2 global_position
| Default | Vector2( 0, 0 ) |
| Setter | set_global_position(value) |
| Getter | get_global_position() |
The global mouse position relative to the current Viewport when used in Control._gui_input, otherwise is at 0,0.
- Vector2 position
| Default | Vector2( 0, 0 ) |
| Setter | set_position(value) |
| Getter | get_position() |
The local mouse position relative to the Viewport. If used in Control._gui_input, the position is relative to the current Control which is under the mouse.