InputEventMouseMotion

InputEventMouseMotion

Inherits: InputEventMouse < InputEventWithModifiers < InputEvent < Resource < Reference < Object

Input event type for mouse motion events.

Description

Contains mouse and pen motion information. Supports relative, absolute positions and speed. See Node._input.

Note: The behavior of this event is affected by the value of Input.use_accumulated_input. When set to true (default), mouse/pen motion events received from the OS will be merged to emit an accumulated event only once per frame rendered at most. When set to false, the events will be emitted as received, which means that they can be emitted multiple times per frame rendered, allowing for precise input reporting at the expense of CPU usage.

Note: 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.

Tutorials

Properties

bool	pen_inverted	`false`
float	pressure	`0.0`
Vector2	relative	`Vector2( 0, 0 )`
Vector2	speed	`Vector2( 0, 0 )`
Vector2	tilt	`Vector2( 0, 0 )`

Property Descriptions

bool pen_inverted

Default	`false`
Setter	set_pen_inverted(value)
Getter	get_pen_inverted()

Returns true when using the eraser end of a stylus pen.

Note: This property is implemented on Linux, macOS and Windows.

float pressure

Default	`0.0`
Setter	set_pressure(value)
Getter	get_pressure()

Represents the pressure the user puts on the pen. Ranges from 0.0 to 1.0.

Vector2 relative

Default	`Vector2( 0, 0 )`
Setter	set_relative(value)
Getter	get_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 speed

Default	`Vector2( 0, 0 )`
Setter	set_speed(value)
Getter	get_speed()

The mouse speed in pixels per second.

Vector2 tilt

Default	`Vector2( 0, 0 )`
Setter	set_tilt(value)
Getter	get_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 to 1.0 for both axes.