godot-docs/classes/class_inputeventmouse.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the InputEventMouse.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_InputEventMouse:

InputEventMouse
===============

**Inherits:** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`InputEventMouseButton<class_InputEventMouseButton>`, :ref:`InputEventMouseMotion<class_InputEventMouseMotion>`

**Category:** Core

Brief Description
-----------------

Base input event type for mouse events.

Properties
----------

+-------------------------------+------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>`         | :ref:`button_mask<class_InputEventMouse_property_button_mask>`         | 0               |
+-------------------------------+------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`global_position<class_InputEventMouse_property_global_position>` | Vector2( 0, 0 ) |
+-------------------------------+------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_InputEventMouse_property_position>`               | Vector2( 0, 0 ) |
+-------------------------------+------------------------------------------------------------------------+-----------------+

Description
-----------

Stores general mouse events information.

Tutorials
---------

- :doc:`../tutorials/inputs/inputevent`

Property Descriptions
---------------------

.. _class_InputEventMouse_property_button_mask:

- :ref:`int<class_int>` **button_mask**

+-----------+------------------------+
| *Default* | 0                      |
+-----------+------------------------+
| *Setter*  | set_button_mask(value) |
+-----------+------------------------+
| *Getter*  | get_button_mask()      |
+-----------+------------------------+

The mouse button mask identifier, one of or a bitwise combination of the :ref:`ButtonList<enum_@GlobalScope_ButtonList>` button masks.

.. _class_InputEventMouse_property_global_position:

- :ref:`Vector2<class_Vector2>` **global_position**

+-----------+----------------------------+
| *Default* | Vector2( 0, 0 )            |
+-----------+----------------------------+
| *Setter*  | set_global_position(value) |
+-----------+----------------------------+
| *Getter*  | get_global_position()      |
+-----------+----------------------------+

The global mouse position relative to the current :ref:`Viewport<class_Viewport>` when used in :ref:`Control._gui_input<class_Control_method__gui_input>`, otherwise is at 0,0.

.. _class_InputEventMouse_property_position:

- :ref:`Vector2<class_Vector2>` **position**

+-----------+---------------------+
| *Default* | Vector2( 0, 0 )     |
+-----------+---------------------+
| *Setter*  | set_position(value) |
+-----------+---------------------+
| *Getter*  | get_position()      |
+-----------+---------------------+

The local mouse position relative to the :ref:`Viewport<class_Viewport>`. If used in :ref:`Control._gui_input<class_Control_method__gui_input>`, the position is relative to the current :ref:`Control<class_Control>` which is under the mouse.