:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/InputEventMouseMotion.xml. .. _class_InputEventMouseMotion: InputEventMouseMotion ===================== **Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEventFromWindow` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Represents a mouse or a pen movement. .. rst-class:: classref-introduction-group Description ----------- Stores information about a mouse or a pen motion. This includes relative position, absolute position, and velocity. See :ref:`Node._input`. \ **Note:** By default, this event is only emitted once per frame rendered at most. If you need more precise input reporting, set :ref:`Input.use_accumulated_input` to ``false`` to make events emitted as often as possible. If you use InputEventMouseMotion to draw lines, consider implementing `Bresenham's line algorithm `__ as well to avoid visible gaps in lines if the user is moving the mouse quickly. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Using InputEvent <../tutorials/inputs/inputevent>` - :doc:`Mouse and input coordinates <../tutorials/inputs/mouse_and_input_coordinates>` - `3D Voxel Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+------------------------------------------------------------------------------+-------------------+ | :ref:`bool` | :ref:`pen_inverted` | ``false`` | +-------------------------------+------------------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`pressure` | ``0.0`` | +-------------------------------+------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`relative` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`screen_relative` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`screen_velocity` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`tilt` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`velocity` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_InputEventMouseMotion_property_pen_inverted: .. rst-class:: classref-property :ref:`bool` **pen_inverted** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pen_inverted**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **get_pen_inverted**\ (\ ) Returns ``true`` when using the eraser end of a stylus pen. \ **Note:** This property is implemented on Linux, macOS and Windows. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_pressure: .. rst-class:: classref-property :ref:`float` **pressure** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pressure**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_pressure**\ (\ ) Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0``. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_relative: .. rst-class:: classref-property :ref:`Vector2` **relative** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_relative**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **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. \ **Note:** :ref:`relative` is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means mouse sensitivity will appear different depending on resolution when using :ref:`relative` in a script that handles mouse aiming with the :ref:`Input.MOUSE_MODE_CAPTURED` mouse mode. To avoid this, use :ref:`screen_relative` instead. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_screen_relative: .. rst-class:: classref-property :ref:`Vector2` **screen_relative** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_screen_relative**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_screen_relative**\ (\ ) The unscaled mouse position relative to the previous position in the coordinate system of the screen (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. This coordinate is *not* scaled according to the content scale factor or calls to :ref:`InputEvent.xformed_by`. This should be preferred over :ref:`relative` for mouse aiming when using the :ref:`Input.MOUSE_MODE_CAPTURED` mouse mode, regardless of the project's stretch mode. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_screen_velocity: .. rst-class:: classref-property :ref:`Vector2` **screen_velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_screen_velocity**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_screen_velocity**\ (\ ) The unscaled mouse velocity in pixels per second in screen coordinates. This velocity is *not* scaled according to the content scale factor or calls to :ref:`InputEvent.xformed_by`. This should be preferred over :ref:`velocity` for mouse aiming when using the :ref:`Input.MOUSE_MODE_CAPTURED` mouse mode, regardless of the project's stretch mode. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_tilt: .. rst-class:: classref-property :ref:`Vector2` **tilt** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_tilt**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **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. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_velocity: .. rst-class:: classref-property :ref:`Vector2` **velocity** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_velocity**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_velocity**\ (\ ) The mouse velocity in pixels per second. \ **Note:** :ref:`velocity` is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means mouse sensitivity will appear different depending on resolution when using :ref:`velocity` in a script that handles mouse aiming with the :ref:`Input.MOUSE_MODE_CAPTURED` mouse mode. To avoid this, use :ref:`screen_velocity` instead. .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`