mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
108 lines
3.7 KiB
ReStructuredText
108 lines
3.7 KiB
ReStructuredText
: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.
|
|
|
|
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 the previous position (position at the last frame).
|
|
|
|
----
|
|
|
|
.. _class_InputEventScreenDrag_property_speed:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **speed**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``Vector2( 0, 0 )`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_speed(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | 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.)`
|