mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current master branch (f87858a8f)
This commit is contained in:
@@ -14,91 +14,108 @@ InputEventMouseButton
|
||||
|
||||
Input event type for mouse button events.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Contains mouse click information. See :ref:`Node._input<class_Node_method__input>`.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`Mouse and input coordinates <../tutorials/inputs/mouse_and_input_coordinates>`
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`MouseButton<enum_@GlobalScope_MouseButton>` | :ref:`button_index<class_InputEventMouseButton_property_button_index>` | ``0`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`double_click<class_InputEventMouseButton_property_double_click>` | ``false`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`factor<class_InputEventMouseButton_property_factor>` | ``1.0`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventMouseButton_property_pressed>` | ``false`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`MouseButton<enum_@GlobalScope_MouseButton>` | :ref:`button_index<class_InputEventMouseButton_property_button_index>` | ``0`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`double_click<class_InputEventMouseButton_property_double_click>` | ``false`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`float<class_float>` | :ref:`factor<class_InputEventMouseButton_property_factor>` | ``1.0`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventMouseButton_property_pressed>` | ``false`` |
|
||||
+---------------------------------------------------+------------------------------------------------------------------------+-----------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_InputEventMouseButton_property_button_index:
|
||||
|
||||
- :ref:`MouseButton<enum_@GlobalScope_MouseButton>` **button_index**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_button_index(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_button_index() |
|
||||
+-----------+-------------------------+
|
||||
:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **button_index** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_button_index** **(** :ref:`MouseButton<enum_@GlobalScope_MouseButton>` value **)**
|
||||
- :ref:`MouseButton<enum_@GlobalScope_MouseButton>` **get_button_index** **(** **)**
|
||||
|
||||
The mouse button identifier, one of the :ref:`MouseButton<enum_@GlobalScope_MouseButton>` button or button wheel constants.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_InputEventMouseButton_property_double_click:
|
||||
|
||||
- :ref:`bool<class_bool>` **double_click**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_double_click(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | is_double_click() |
|
||||
+-----------+-------------------------+
|
||||
:ref:`bool<class_bool>` **double_click** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_double_click** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_double_click** **(** **)**
|
||||
|
||||
If ``true``, the mouse button's state is a double-click.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_InputEventMouseButton_property_factor:
|
||||
|
||||
- :ref:`float<class_float>` **factor**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_factor(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_factor() |
|
||||
+-----------+-------------------+
|
||||
:ref:`float<class_float>` **factor** = ``1.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_factor** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_factor** **(** **)**
|
||||
|
||||
The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be ``0`` if not supported.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_InputEventMouseButton_property_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **pressed**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_pressed(value) |
|
||||
+-----------+--------------------+
|
||||
| *Getter* | is_pressed() |
|
||||
+-----------+--------------------+
|
||||
:ref:`bool<class_bool>` **pressed** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
If ``true``, the mouse button's state is pressed. If ``false``, the mouse button's state is released.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user