Files
godot-docs/classes/class_inputeventjoypadbutton.rst
2017-06-17 11:32:15 +02:00

64 lines
3.1 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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 type for joypad button events.
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
----------------
- :ref:`int<class_int>` **button_index** - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope].
- :ref:`bool<class_bool>` **pressed** - Pressed state of the joypad button.
- :ref:`float<class_float>` **pressure** - Intensity of the button pressure, ranges from 0 to 1.0.
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 **)**