mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
109 lines
3.8 KiB
ReStructuredText
109 lines
3.8 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:`float<class_float>` | :ref:`pressure<class_InputEventMouseMotion_property_pressure>` | 0.0 |
|
|
+-------------------------------+----------------------------------------------------------------+-----------------+
|
|
| :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 ) |
|
|
+-------------------------------+----------------------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`tilt<class_InputEventMouseMotion_property_tilt>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+----------------------------------------------------------------+-----------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Contains mouse and pen 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_pressure:
|
|
|
|
- :ref:`float<class_float>` **pressure**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | 0.0 |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_pressure(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_pressure() |
|
|
+-----------+---------------------+
|
|
|
|
Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0``.
|
|
|
|
----
|
|
|
|
.. _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.
|
|
|
|
----
|
|
|
|
.. _class_InputEventMouseMotion_property_tilt:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **tilt**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
| *Setter* | set_tilt(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_tilt() |
|
|
+-----------+-----------------+
|
|
|
|
Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from ``-1.0`` to ``1.0`` for both axes.
|
|
|