mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
81 lines
2.5 KiB
ReStructuredText
81 lines
2.5 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the InputEventScreenTouch.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_InputEventScreenTouch:
|
|
|
|
InputEventScreenTouch
|
|
=====================
|
|
|
|
**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Input event type for screen touch events.
|
|
|
|
(only available on mobile devices)
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+----------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`index<class_InputEventScreenTouch_property_index>` |
|
|
+-------------------------------+----------------------------------------------------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_InputEventScreenTouch_property_position>` |
|
|
+-------------------------------+----------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventScreenTouch_property_pressed>` |
|
|
+-------------------------------+----------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Stores multi-touch press/release information. Supports touch press, touch release and :ref:`index<class_InputEventScreenTouch_property_index>` for multi-touch count and order.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/inputs/inputevent`
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_InputEventScreenTouch_property_index:
|
|
|
|
- :ref:`int<class_int>` **index**
|
|
|
|
+----------+------------------+
|
|
| *Setter* | set_index(value) |
|
|
+----------+------------------+
|
|
| *Getter* | get_index() |
|
|
+----------+------------------+
|
|
|
|
Touch index in the case of a multi-touch event. One index = one finger.
|
|
|
|
.. _class_InputEventScreenTouch_property_position:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **position**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_position(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | get_position() |
|
|
+----------+---------------------+
|
|
|
|
Touch position.
|
|
|
|
.. _class_InputEventScreenTouch_property_pressed:
|
|
|
|
- :ref:`bool<class_bool>` **pressed**
|
|
|
|
+----------+--------------------+
|
|
| *Setter* | set_pressed(value) |
|
|
+----------+--------------------+
|
|
| *Getter* | is_pressed() |
|
|
+----------+--------------------+
|
|
|
|
If ``true``, the touch's state is pressed. If ``false``, the touch's state is released.
|
|
|