Files
godot-docs/classes/class_inputeventmousebutton.rst
2018-01-18 22:02:30 +01:00

44 lines
1.6 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 Variables
----------------
.. _class_InputEventMouseButton_button_index:
- :ref:`int<class_int>` **button_index** - Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope<class_@globalscope>`.
.. _class_InputEventMouseButton_doubleclick:
- :ref:`bool<class_bool>` **doubleclick** - If ``true`` the mouse button's state is a double-click. If ``false`` the mouse button's state is released.
.. _class_InputEventMouseButton_factor:
- :ref:`float<class_float>` **factor** - TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does
.. _class_InputEventMouseButton_pressed:
- :ref:`bool<class_bool>` **pressed** - If ``true`` the mouse button's state is pressed. If ``false`` the mouse button's state is released.
Description
-----------
Contains mouse click information. See :ref:`Node._input<class_Node__input>`.