mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
104 lines
3.3 KiB
ReStructuredText
104 lines
3.3 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. 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>`
|
|
|
|
Input event type for screen drag events. Only available on mobile devices.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Contains screen drag information. See :ref:`Node._input<class_Node_method__input>`.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/inputs/inputevent`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`int<class_int>` | :ref:`index<class_InputEventScreenDrag_property_index>` | ``0`` |
|
|
+-------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_InputEventScreenDrag_property_position>` | ``Vector2( 0, 0 )`` |
|
|
+-------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`relative<class_InputEventScreenDrag_property_relative>` | ``Vector2( 0, 0 )`` |
|
|
+-------------------------------+---------------------------------------------------------------+---------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`speed<class_InputEventScreenDrag_property_speed>` | ``Vector2( 0, 0 )`` |
|
|
+-------------------------------+---------------------------------------------------------------+---------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_InputEventScreenDrag_property_index:
|
|
|
|
- :ref:`int<class_int>` **index**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+------------------+
|
|
| *Setter* | set_index(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_index() |
|
|
+-----------+------------------+
|
|
|
|
The drag event index in the case of a multi-drag event.
|
|
|
|
----
|
|
|
|
.. _class_InputEventScreenDrag_property_position:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **position**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_position(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_position() |
|
|
+-----------+---------------------+
|
|
|
|
The drag position.
|
|
|
|
----
|
|
|
|
.. _class_InputEventScreenDrag_property_relative:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **relative**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_relative(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_relative() |
|
|
+-----------+---------------------+
|
|
|
|
The drag position relative to its start position.
|
|
|
|
----
|
|
|
|
.. _class_InputEventScreenDrag_property_speed:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **speed**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_speed(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_speed() |
|
|
+-----------+---------------------+
|
|
|
|
The drag speed.
|
|
|