godot-docs/classes/class_inputeventscreendrag.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/InputEventScreenDrag.xml.

.. _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.

.. rst-class:: classref-introduction-group

Description
-----------

Contains screen drag information. See :ref:`Node._input<class_Node_method__input>`.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`../tutorials/inputs/inputevent`

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-------------------------------+---------------------------------------------------------------+---------------------+
   | :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 )`` |
   +-------------------------------+---------------------------------------------------------------+---------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_InputEventScreenDrag_property_index:

.. rst-class:: classref-property

:ref:`int<class_int>` **index** = ``0``

.. rst-class:: classref-property-setget

- void **set_index** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_index** **(** **)**

The drag event index in the case of a multi-drag event.

.. rst-class:: classref-item-separator

----

.. _class_InputEventScreenDrag_property_position:

.. rst-class:: classref-property

:ref:`Vector2<class_Vector2>` **position** = ``Vector2( 0, 0 )``

.. rst-class:: classref-property-setget

- void **set_position** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_position** **(** **)**

The drag position.

.. rst-class:: classref-item-separator

----

.. _class_InputEventScreenDrag_property_relative:

.. rst-class:: classref-property

:ref:`Vector2<class_Vector2>` **relative** = ``Vector2( 0, 0 )``

.. rst-class:: classref-property-setget

- void **set_relative** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_relative** **(** **)**

The drag position relative to the previous position (position at the last frame).

.. rst-class:: classref-item-separator

----

.. _class_InputEventScreenDrag_property_speed:

.. rst-class:: classref-property

:ref:`Vector2<class_Vector2>` **speed** = ``Vector2( 0, 0 )``

.. rst-class:: classref-property-setget

- void **set_speed** **(** :ref:`Vector2<class_Vector2>` value **)**
- :ref:`Vector2<class_Vector2>` **get_speed** **(** **)**

The drag speed.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`