| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071 |
- .. 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)
- Member Functions
- ----------------
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_index<class_InputEventScreenTouch_get_index>` **(** **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_vector2>` | :ref:`get_position<class_InputEventScreenTouch_get_position>` **(** **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_index<class_InputEventScreenTouch_set_index>` **(** :ref:`int<class_int>` index **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_position<class_InputEventScreenTouch_set_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_pressed<class_InputEventScreenTouch_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`int<class_int>` **index** - Touch index in the case of a multi-touch event. One index = one finger.
- - :ref:`Vector2<class_vector2>` **position** - Touch position.
- - :ref:`bool<class_bool>` **pressed** - If ``true`` the touch's state is pressed. If ``false`` the touch's state is released.
- Description
- -----------
- Stores multi-touch press/release information. Supports touch press, touch release and member index for multi-touch count and order.
- Member Function Description
- ---------------------------
- .. _class_InputEventScreenTouch_get_index:
- - :ref:`int<class_int>` **get_index** **(** **)** const
- .. _class_InputEventScreenTouch_get_position:
- - :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
- .. _class_InputEventScreenTouch_set_index:
- - void **set_index** **(** :ref:`int<class_int>` index **)**
- .. _class_InputEventScreenTouch_set_position:
- - void **set_position** **(** :ref:`Vector2<class_vector2>` position **)**
- .. _class_InputEventScreenTouch_set_pressed:
- - void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
