godot/doc/classes/InputEventScreenTouch.xml
Rémi Verschelde 967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00

67 lines
1.9 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventScreenTouch" inherits="InputEvent" category="Core" version="3.0-alpha">
<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>
http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html
</tutorials>
<demos>
</demos>
<methods>
<method name="get_index" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
</description>
</method>
<method name="set_index">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
</description>
</method>
<method name="set_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="index" type="int" setter="set_index" getter="get_index">
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">
Touch position.
</member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
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>