| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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:`InputEventFromWindow<class_InputEventFromWindow>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`InputEventMouseButton<class_InputEventMouseButton>`, :ref:`InputEventMouseMotion<class_InputEventMouseMotion>`
- Base input event type for mouse events.
- Description
- -----------
- Stores general mouse events information.
- Tutorials
- ---------
- - :doc:`InputEvent <../tutorials/inputs/inputevent>`
- Properties
- ----------
- +---------------------------------------------------+------------------------------------------------------------------------+-------------------+
- | :ref:`MouseButton<enum_@GlobalScope_MouseButton>` | :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)`` |
- +---------------------------------------------------+------------------------------------------------------------------------+-------------------+
- Property Descriptions
- ---------------------
- .. _class_InputEventMouse_property_button_mask:
- - :ref:`MouseButton<enum_@GlobalScope_MouseButton>` **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:`MouseButton<enum_@GlobalScope_MouseButton>` 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() |
- +-----------+----------------------------+
- When received in :ref:`Node._input<class_Node_method__input>` or :ref:`Node._unhandled_input<class_Node_method__unhandled_input>`, returns the mouse's position in the root :ref:`Viewport<class_Viewport>` using the coordinate system of the root :ref:`Viewport<class_Viewport>`.
- When received in :ref:`Control._gui_input<class_Control_method__gui_input>`, returns the mouse's position in the :ref:`CanvasLayer<class_CanvasLayer>` that the :ref:`Control<class_Control>` is in using the coordinate system of the :ref:`CanvasLayer<class_CanvasLayer>`.
- ----
- .. _class_InputEventMouse_property_position:
- - :ref:`Vector2<class_Vector2>` **position**
- +-----------+---------------------+
- | *Default* | ``Vector2(0, 0)`` |
- +-----------+---------------------+
- | *Setter* | set_position(value) |
- +-----------+---------------------+
- | *Getter* | get_position() |
- +-----------+---------------------+
- When received in :ref:`Node._input<class_Node_method__input>` or :ref:`Node._unhandled_input<class_Node_method__unhandled_input>`, returns the mouse's position in the :ref:`Viewport<class_Viewport>` this :ref:`Node<class_Node>` is in using the coordinate system of this :ref:`Viewport<class_Viewport>`.
- When received in :ref:`Control._gui_input<class_Control_method__gui_input>`, returns the mouse's position in the :ref:`Control<class_Control>` using the local coordinate system of the :ref:`Control<class_Control>`.
- .. |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.)`
|
