Files
godot-docs/classes/class_inputeventscreendrag.rst
2019-01-07 10:14:12 +01:00

95 lines
2.8 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.
(only available on mobile devices)
Properties
----------
+-------------------------------+---------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`index<class_InputEventScreenDrag_property_index>` |
+-------------------------------+---------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_InputEventScreenDrag_property_position>` |
+-------------------------------+---------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`relative<class_InputEventScreenDrag_property_relative>` |
+-------------------------------+---------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`speed<class_InputEventScreenDrag_property_speed>` |
+-------------------------------+---------------------------------------------------------------+
Description
-----------
Contains screen drag information. See :ref:`Node._input<class_Node_method__input>`.
Tutorials
---------
- :doc:`../tutorials/inputs/inputevent`
Property Descriptions
---------------------
.. _class_InputEventScreenDrag_property_index:
- :ref:`int<class_int>` **index**
+----------+------------------+
| *Setter* | set_index(value) |
+----------+------------------+
| *Getter* | get_index() |
+----------+------------------+
Drag event index in the case of a multi-drag event.
.. _class_InputEventScreenDrag_property_position:
- :ref:`Vector2<class_Vector2>` **position**
+----------+---------------------+
| *Setter* | set_position(value) |
+----------+---------------------+
| *Getter* | get_position() |
+----------+---------------------+
Drag position.
.. _class_InputEventScreenDrag_property_relative:
- :ref:`Vector2<class_Vector2>` **relative**
+----------+---------------------+
| *Setter* | set_relative(value) |
+----------+---------------------+
| *Getter* | get_relative() |
+----------+---------------------+
Drag position relative to its start position.
.. _class_InputEventScreenDrag_property_speed:
- :ref:`Vector2<class_Vector2>` **speed**
+----------+------------------+
| *Setter* | set_speed(value) |
+----------+------------------+
| *Getter* | get_speed() |
+----------+------------------+
Drag speed.