| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677 |
- .. 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:`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 :ref:`@Global Scope<class_@global scope>`.
- - :ref:`Vector2<class_vector2>` **global_position** - Mouse position relative to the current :ref:`Viewport<class_viewport>` when used in :ref:`Control._gui_input<class_Control__gui_input>`, otherwise is at 0,0.
- - :ref:`Vector2<class_vector2>` **position** - Mouse local position relative to the :ref:`Viewport<class_viewport>`. If used in :ref:`Control._gui_input<class_Control__gui_input>` the position is relative to the current :ref:`Control<class_control>` wich is under the mouse.
- Description
- -----------
- Stores general mouse events informations.
- 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 **)**
|
