: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//doc_classes. .. _class_InputEventMouseMotion: InputEventMouseMotion ===================== **Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Input event type for mouse motion events. Description ----------- Contains mouse and pen motion information. Supports relative, absolute positions and speed. See :ref:`Node._input`. Tutorials --------- - :doc:`../tutorials/inputs/mouse_and_input_coordinates` Properties ---------- +-------------------------------+----------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`pressure` | ``0.0`` | +-------------------------------+----------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`relative` | ``Vector2( 0, 0 )`` | +-------------------------------+----------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`speed` | ``Vector2( 0, 0 )`` | +-------------------------------+----------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`tilt` | ``Vector2( 0, 0 )`` | +-------------------------------+----------------------------------------------------------------+---------------------+ Property Descriptions --------------------- .. _class_InputEventMouseMotion_property_pressure: - :ref:`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` **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). **Note:** Since ``InputEventMouseMotion`` is only emitted when the mouse moves, the last event won't have a relative position of ``Vector2(0, 0)`` when the user stops moving the mouse. ---- .. _class_InputEventMouseMotion_property_speed: - :ref:`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` **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.