Attention

You are reading the latest (unstable) version of this documentation, which may document features not available or compatible with Godot 3.x.

Checking the stable version of the documentation...

Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

InputEventScreenTouch¶

Inherits: InputEventFromWindow < InputEvent < Resource < RefCounted < Object

Input event type for screen touch events.

(only available on mobile devices)

Description¶

Stores multi-touch press/release information. Supports touch press, touch release and index for multi-touch count and order.

Tutorials¶

InputEvent

Properties¶

bool	double_tap	`false`
int	index	`0`
Vector2	position	`Vector2(0, 0)`
bool	pressed	`false`

Property Descriptions¶

bool double_tap = false

void set_double_tap ( bool value )
bool is_double_tap ( )

If true, the touch's state is a double tap.

int index = 0

void set_index ( int value )
int get_index ( )

The touch index in the case of a multi-touch event. One index = one finger.

Vector2 position = Vector2(0, 0)

void set_position ( Vector2 value )
Vector2 get_position ( )

The touch position, in screen (global) coordinates.

bool pressed = false

void set_pressed ( bool value )
bool is_pressed ( )

If true, the touch's state is pressed. If false, the touch's state is released.