Attention: Here be dragons
This is the
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Represents a mouse or a pen movement.
Stores information about a mouse or a pen motion. This includes relative position, absolute position, and velocity. See Node._input.
Note: By default, this event is only emitted once per frame rendered at most. If you need more precise input reporting, set Input.use_accumulated_input to
false to make events emitted as often as possible. If you use InputEventMouseMotion to draw lines, consider implementing Bresenham's line algorithm as well to avoid visible gaps in lines if the user is moving the mouse quickly.
bool pen_inverted =
true when using the eraser end of a stylus pen.
Note: This property is implemented on Linux, macOS and Windows.
float pressure =
Represents the pressure the user puts on the pen. Ranges from
Vector2 relative =
The mouse position relative to the previous position (position at the last frame).
Note: Since InputEventMouseMotion is only emitted when the mouse moves, the last event won't have a relative position of
Vector2(0, 0) when the user stops moving the mouse.
Vector2 tilt =
Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from
1.0 for both axes.
Vector2 velocity =
The mouse velocity in pixels per second.