godot/doc/classes/InputEventScreenTouch.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventScreenTouch" inherits="InputEvent" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Input event type for screen touch events.
		(only available on mobile devices)
	</brief_description>
	<description>
		Stores multi-touch press/release information. Supports touch press, touch release and [member index] for multi-touch count and order.
	</description>
	<tutorials>
		<link>$DOCS_URL/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="canceled" type="bool" setter="set_canceled" getter="is_canceled" default="false">
			If [code]true[/code], the touch event has been canceled.
		</member>
		<member name="double_tap" type="bool" setter="set_double_tap" getter="is_double_tap" default="false">
			If [code]true[/code], the touch's state is a double tap.
		</member>
		<member name="index" type="int" setter="set_index" getter="get_index" default="0">
			The touch index in the case of a multi-touch event. One index = one finger.
		</member>
		<member name="position" type="Vector2" setter="set_position" getter="get_position" default="Vector2( 0, 0 )">
			The touch position.
		</member>
		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
			If [code]true[/code], the touch's state is pressed. If [code]false[/code], the touch's state is released.
		</member>
	</members>
	<constants>
	</constants>
</class>