mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
78 lines
4.2 KiB
ReStructuredText
78 lines
4.2 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the InputEventMouseButton.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_InputEventMouseButton:
|
|
|
|
InputEventMouseButton
|
|
=====================
|
|
|
|
**Inherits:** :ref:`InputEventMouse<class_inputeventmouse>` **<** :ref:`InputEventWithModifiers<class_inputeventwithmodifiers>` **<** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Input event type for mouse button events.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_button_index<class_InputEventMouseButton_get_button_index>` **(** **)** const |
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_factor<class_InputEventMouseButton_get_factor>` **(** **)** |
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_doubleclick<class_InputEventMouseButton_is_doubleclick>` **(** **)** const |
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_button_index<class_InputEventMouseButton_set_button_index>` **(** :ref:`int<class_int>` button_index **)** |
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_doubleclick<class_InputEventMouseButton_set_doubleclick>` **(** :ref:`bool<class_bool>` doubleclick **)** |
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_factor<class_InputEventMouseButton_set_factor>` **(** :ref:`float<class_float>` factor **)** |
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_pressed<class_InputEventMouseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
|
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
- :ref:`int<class_int>` **button_index** - Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope].
|
|
- :ref:`bool<class_bool>` **doubleclick** - Whether the event is a double-click.
|
|
- :ref:`float<class_float>` **factor**
|
|
- :ref:`bool<class_bool>` **pressed** - Pressed state of the mouse button.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_InputEventMouseButton_get_button_index:
|
|
|
|
- :ref:`int<class_int>` **get_button_index** **(** **)** const
|
|
|
|
.. _class_InputEventMouseButton_get_factor:
|
|
|
|
- :ref:`float<class_float>` **get_factor** **(** **)**
|
|
|
|
.. _class_InputEventMouseButton_is_doubleclick:
|
|
|
|
- :ref:`bool<class_bool>` **is_doubleclick** **(** **)** const
|
|
|
|
.. _class_InputEventMouseButton_set_button_index:
|
|
|
|
- void **set_button_index** **(** :ref:`int<class_int>` button_index **)**
|
|
|
|
.. _class_InputEventMouseButton_set_doubleclick:
|
|
|
|
- void **set_doubleclick** **(** :ref:`bool<class_bool>` doubleclick **)**
|
|
|
|
.. _class_InputEventMouseButton_set_factor:
|
|
|
|
- void **set_factor** **(** :ref:`float<class_float>` factor **)**
|
|
|
|
.. _class_InputEventMouseButton_set_pressed:
|
|
|
|
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
|
|
|
|