mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
79 lines
3.6 KiB
ReStructuredText
79 lines
3.6 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the InputEventJoypadButton.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_InputEventJoypadButton:
|
|
|
|
InputEventJoypadButton
|
|
======================
|
|
|
|
**Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Input event for gamepad buttons.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_button_index<class_InputEventJoypadButton_get_button_index>` **(** **)** const |
|
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_pressure<class_InputEventJoypadButton_get_pressure>` **(** **)** const |
|
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_button_index<class_InputEventJoypadButton_set_button_index>` **(** :ref:`int<class_int>` button_index **)** |
|
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_pressed<class_InputEventJoypadButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_pressure<class_InputEventJoypadButton_set_pressure>` **(** :ref:`float<class_float>` pressure **)** |
|
|
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_InputEventJoypadButton_button_index:
|
|
|
|
- :ref:`int<class_int>` **button_index** - Button identifier. One of the ``JOY_BUTTON\_\*`` constants from @global Scope.
|
|
|
|
.. _class_InputEventJoypadButton_pressed:
|
|
|
|
- :ref:`bool<class_bool>` **pressed** - If ``true`` the button's state is pressed. If ``false`` the button's state is released.
|
|
|
|
.. _class_InputEventJoypadButton_pressure:
|
|
|
|
- :ref:`float<class_float>` **pressure** - Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
Input event type for gamepad buttons. For joysticks see :ref:`InputEventJoypadMotion<class_inputeventjoypadmotion>`.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_InputEventJoypadButton_get_button_index:
|
|
|
|
- :ref:`int<class_int>` **get_button_index** **(** **)** const
|
|
|
|
.. _class_InputEventJoypadButton_get_pressure:
|
|
|
|
- :ref:`float<class_float>` **get_pressure** **(** **)** const
|
|
|
|
.. _class_InputEventJoypadButton_set_button_index:
|
|
|
|
- void **set_button_index** **(** :ref:`int<class_int>` button_index **)**
|
|
|
|
.. _class_InputEventJoypadButton_set_pressed:
|
|
|
|
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
|
|
|
.. _class_InputEventJoypadButton_set_pressure:
|
|
|
|
- void **set_pressure** **(** :ref:`float<class_float>` pressure **)**
|
|
|
|
|