Files
godot-docs/classes/class_inputeventscreendrag.rst
2017-09-23 11:01:36 +02:00

84 lines
4.4 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the InputEventScreenDrag.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_InputEventScreenDrag:
InputEventScreenDrag
====================
**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 drag events.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_index<class_InputEventScreenDrag_get_index>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_InputEventScreenDrag_get_position>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_relative<class_InputEventScreenDrag_get_relative>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_speed<class_InputEventScreenDrag_get_speed>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_index<class_InputEventScreenDrag_set_index>` **(** :ref:`int<class_int>` index **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_position<class_InputEventScreenDrag_set_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_relative<class_InputEventScreenDrag_set_relative>` **(** :ref:`Vector2<class_vector2>` relative **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed<class_InputEventScreenDrag_set_speed>` **(** :ref:`Vector2<class_vector2>` speed **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **index** - Drag event index in the case of a multi-drag event.
- :ref:`Vector2<class_vector2>` **position** - Position of the drag event.
- :ref:`Vector2<class_vector2>` **relative** - Position of the drag event relative to its start position.
- :ref:`Vector2<class_vector2>` **speed** - Speed of the drag event.
Member Function Description
---------------------------
.. _class_InputEventScreenDrag_get_index:
- :ref:`int<class_int>` **get_index** **(** **)** const
.. _class_InputEventScreenDrag_get_position:
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
.. _class_InputEventScreenDrag_get_relative:
- :ref:`Vector2<class_vector2>` **get_relative** **(** **)** const
.. _class_InputEventScreenDrag_get_speed:
- :ref:`Vector2<class_vector2>` **get_speed** **(** **)** const
.. _class_InputEventScreenDrag_set_index:
- void **set_index** **(** :ref:`int<class_int>` index **)**
.. _class_InputEventScreenDrag_set_position:
- void **set_position** **(** :ref:`Vector2<class_vector2>` position **)**
.. _class_InputEventScreenDrag_set_relative:
- void **set_relative** **(** :ref:`Vector2<class_vector2>` relative **)**
.. _class_InputEventScreenDrag_set_speed:
- void **set_speed** **(** :ref:`Vector2<class_vector2>` speed **)**