InputEventMouseMotion

Inherits: InputEventMouse < InputEventWithModifiers < InputEventFromWindow < InputEvent < Resource < RefCounted < Object

Input event type for mouse motion events.

Description

Contains mouse and pen motion information. Supports relative, absolute positions 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.

Tutorials

Properties

bool

pen_inverted

false

float

pressure

0.0

Vector2

relative

Vector2(0, 0)

Vector2

tilt

Vector2(0, 0)

Vector2

velocity

Vector2(0, 0)

Property Descriptions

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.


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.


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.


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.


Default

Vector2(0, 0)

Setter

set_velocity(value)

Getter

get_velocity()

The mouse velocity in pixels per second.