mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
130 lines
4.6 KiB
ReStructuredText
130 lines
4.6 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventScreenTouch.xml.
|
|
|
|
.. _class_InputEventScreenTouch:
|
|
|
|
InputEventScreenTouch
|
|
=====================
|
|
|
|
**Inherits:** :ref:`InputEventFromWindow<class_InputEventFromWindow>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Input event type for screen touch events.
|
|
|
|
(only available on mobile devices)
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
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.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`InputEvent <../tutorials/inputs/inputevent>`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------+--------------------------------------------------------------------+-------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`double_tap<class_InputEventScreenTouch_property_double_tap>` | ``false`` |
|
|
+-------------------------------+--------------------------------------------------------------------+-------------------+
|
|
| :ref:`int<class_int>` | :ref:`index<class_InputEventScreenTouch_property_index>` | ``0`` |
|
|
+-------------------------------+--------------------------------------------------------------------+-------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_InputEventScreenTouch_property_position>` | ``Vector2(0, 0)`` |
|
|
+-------------------------------+--------------------------------------------------------------------+-------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventScreenTouch_property_pressed>` | ``false`` |
|
|
+-------------------------------+--------------------------------------------------------------------+-------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_InputEventScreenTouch_property_double_tap:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **double_tap** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_double_tap** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **is_double_tap** **(** **)**
|
|
|
|
If ``true``, the touch's state is a double tap.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_InputEventScreenTouch_property_index:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **index** = ``0``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_index** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_int>` **get_index** **(** **)**
|
|
|
|
The touch index in the case of a multi-touch event. One index = one finger.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_InputEventScreenTouch_property_position:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector2<class_Vector2>` **position** = ``Vector2(0, 0)``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_position** **(** :ref:`Vector2<class_Vector2>` value **)**
|
|
- :ref:`Vector2<class_Vector2>` **get_position** **(** **)**
|
|
|
|
The touch position, in screen (global) coordinates.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_InputEventScreenTouch_property_pressed:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **pressed** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_pressed** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
|
|
|
If ``true``, the touch's state is pressed. If ``false``, the touch's state is released.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|