class_inputeventscreentouch.rst 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the InputEventScreenTouch.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_InputEventScreenTouch:
  5. InputEventScreenTouch
  6. =====================
  7. **Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Input event type for screen touch events.
  12. (only available on mobile devices)
  13. Member Variables
  14. ----------------
  15. .. _class_InputEventScreenTouch_index:
  16. - :ref:`int<class_int>` **index** - Touch index in the case of a multi-touch event. One index = one finger.
  17. .. _class_InputEventScreenTouch_position:
  18. - :ref:`Vector2<class_vector2>` **position** - Touch position.
  19. .. _class_InputEventScreenTouch_pressed:
  20. - :ref:`bool<class_bool>` **pressed** - If ``true`` the touch's state is pressed. If ``false`` the touch's state is released.
  21. Description
  22. -----------
  23. Stores multi-touch press/release information. Supports touch press, touch release and :ref:`index<class_InputEventScreenTouch_index>` for multi-touch count and order.