Files
godot-docs/classes/class_inputeventmousemotion.rst

71 lines
2.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 InputEventMouseMotion.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_InputEventMouseMotion:
InputEventMouseMotion
=====================
**Inherits:** :ref:`InputEventMouse<class_InputEventMouse>` **<** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Input event type for mouse motion events.
Properties
----------
+-------------------------------+----------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`relative<class_InputEventMouseMotion_property_relative>` | Vector2( 0, 0 ) |
+-------------------------------+----------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`speed<class_InputEventMouseMotion_property_speed>` | Vector2( 0, 0 ) |
+-------------------------------+----------------------------------------------------------------+-----------------+
Description
-----------
Contains mouse motion information. Supports relative, absolute positions and speed. See :ref:`Node._input<class_Node_method__input>`.
Tutorials
---------
- :doc:`../tutorials/inputs/mouse_and_input_coordinates`
Property Descriptions
---------------------
.. _class_InputEventMouseMotion_property_relative:
- :ref:`Vector2<class_Vector2>` **relative**
+-----------+---------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+---------------------+
| *Setter* | set_relative(value) |
+-----------+---------------------+
| *Getter* | get_relative() |
+-----------+---------------------+
The mouse position relative to the previous position (position at the last frame).
.. _class_InputEventMouseMotion_property_speed:
- :ref:`Vector2<class_Vector2>` **speed**
+-----------+------------------+
| *Default* | Vector2( 0, 0 ) |
+-----------+------------------+
| *Setter* | set_speed(value) |
+-----------+------------------+
| *Getter* | get_speed() |
+-----------+------------------+
The mouse speed in pixels per second.