Class InputEventScreenDrag

Represents a screen drag event.

Inheritance

InputEventFromWindow

InputEvent

Resource

RefCounted

Object

InputEventScreenDrag

Remarks

Stores information about screen drag events. See Node._input.

See Also

Using InputEvent

Properties

index

The drag event index in the case of a multi-drag event.

var index : int = 0

Property Value

int

Remarks

• void set_index(int value)
• int get_index

pen_inverted

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

var pen_inverted : bool = false

Property Value

bool

Remarks

• void set_pen_inverted(bool value)
• bool get_pen_inverted

position

The drag position in the viewport the node is in, using the coordinate system of this viewport.

var position : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_position(Vector2 value)
• Vector2 get_position

pressure

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

var pressure : float = 0.0

Property Value

float

Remarks

• void set_pressure(float value)
• float get_pressure

relative

The drag position relative to the previous position (position at the last frame).

Note: relative is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using relative in a script that handles touch aiming. To avoid this, use screen_relative instead.

var relative : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_relative(Vector2 value)
• Vector2 get_relative

screen_relative

The unscaled drag position relative to the previous position in screen coordinates (position at the last frame). This position is not scaled according to the content scale factor or calls to InputEvent.xformed_by. This should be preferred over relative for touch aiming regardless of the project's stretch mode.

var screen_relative : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_screen_relative(Vector2 value)
• Vector2 get_screen_relative

screen_velocity

The unscaled drag velocity in pixels per second in screen coordinates. This velocity is not scaled according to the content scale factor or calls to InputEvent.xformed_by. This should be preferred over velocity for touch aiming regardless of the project's stretch mode.

var screen_velocity : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_screen_velocity(Vector2 value)
• Vector2 get_screen_velocity

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.

var tilt : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_tilt(Vector2 value)
• Vector2 get_tilt

velocity

The drag velocity.

Note: velocity is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using velocity in a script that handles touch aiming. To avoid this, use screen_velocity instead.

var velocity : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_velocity(Vector2 value)
• Vector2 get_velocity