summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventScreenTouch.xml
blob: fb50454917a44b58987ab8c22b9372bcb60369a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventScreenTouch" inherits="InputEventFromWindow" version="4.0" 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 title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<members>
		<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, in screen (global) coordinates.
		</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>
</class>