mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
72 lines
3.9 KiB
ReStructuredText
72 lines
3.9 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _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:`InputEventMouseMotion<class_inputeventmousemotion>`, :ref:`InputEventMouseButton<class_inputeventmousebutton>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Base input event type for mouse events.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_button_mask<class_InputEventMouse_get_button_mask>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_global_position<class_InputEventMouse_get_global_position>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_InputEventMouse_get_position>` **(** **)** const |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_button_mask<class_InputEventMouse_set_button_mask>` **(** :ref:`int<class_int>` button_mask **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_global_position<class_InputEventMouse_set_global_position>` **(** :ref:`Vector2<class_vector2>` global_position **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_position<class_InputEventMouse_set_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
|
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`int<class_int>` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
|
|
- :ref:`Vector2<class_vector2>` **global_position** - Global position of the mouse click.
|
|
- :ref:`Vector2<class_vector2>` **position** - Local position of the mouse click.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_InputEventMouse_get_button_mask:
|
|
|
|
- :ref:`int<class_int>` **get_button_mask** **(** **)** const
|
|
|
|
.. _class_InputEventMouse_get_global_position:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_global_position** **(** **)** const
|
|
|
|
.. _class_InputEventMouse_get_position:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
|
|
|
|
.. _class_InputEventMouse_set_button_mask:
|
|
|
|
- void **set_button_mask** **(** :ref:`int<class_int>` button_mask **)**
|
|
|
|
.. _class_InputEventMouse_set_global_position:
|
|
|
|
- void **set_global_position** **(** :ref:`Vector2<class_vector2>` global_position **)**
|
|
|
|
.. _class_InputEventMouse_set_position:
|
|
|
|
- void **set_position** **(** :ref:`Vector2<class_vector2>` position **)**
|
|
|
|
|