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: By default, this event can be emitted multiple times per frame rendered, allowing for precise input reporting, at the expense of CPU usage. You can call Input.set_use_accumulated_input with true to let multiple events merge into a single emitted event per frame.

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

Mouse and input coordinates

Properties

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

Property Descriptions

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.