class_inputeventscreentouch.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_InputEventScreenTouch:
  4. InputEventScreenTouch
  5. =====================
  6. **Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Input event type for screen touch events.
  11. Member Functions
  12. ----------------
  13. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  14. | :ref:`int<class_int>` | :ref:`get_index<class_InputEventScreenTouch_get_index>` **(** **)** const |
  15. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  16. | :ref:`Vector2<class_vector2>` | :ref:`get_position<class_InputEventScreenTouch_get_position>` **(** **)** const |
  17. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_index<class_InputEventScreenTouch_set_index>` **(** :ref:`int<class_int>` index **)** |
  19. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_position<class_InputEventScreenTouch_set_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
  21. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_pressed<class_InputEventScreenTouch_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
  23. +--------------------------------+---------------------------------------------------------------------------------------------------------------+
  24. Member Variables
  25. ----------------
  26. - :ref:`int<class_int>` **index** - Touch event index in the case of a multi-touch event.
  27. - :ref:`Vector2<class_vector2>` **position** - Position of the touch event.
  28. - :ref:`bool<class_bool>` **pressed** - Pressed state of the touch event.
  29. Member Function Description
  30. ---------------------------
  31. .. _class_InputEventScreenTouch_get_index:
  32. - :ref:`int<class_int>` **get_index** **(** **)** const
  33. .. _class_InputEventScreenTouch_get_position:
  34. - :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
  35. .. _class_InputEventScreenTouch_set_index:
  36. - void **set_index** **(** :ref:`int<class_int>` index **)**
  37. .. _class_InputEventScreenTouch_set_position:
  38. - void **set_position** **(** :ref:`Vector2<class_vector2>` pos **)**
  39. .. _class_InputEventScreenTouch_set_pressed:
  40. - void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**