class_inputeventjoypadbutton.rst 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the InputEventJoypadButton.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_InputEventJoypadButton:
  5. InputEventJoypadButton
  6. ======================
  7. **Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Input event type for joypad button events.
  12. Member Functions
  13. ----------------
  14. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_button_index<class_InputEventJoypadButton_get_button_index>` **(** **)** const |
  16. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`get_pressure<class_InputEventJoypadButton_get_pressure>` **(** **)** const |
  18. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_button_index<class_InputEventJoypadButton_set_button_index>` **(** :ref:`int<class_int>` button_index **)** |
  20. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_pressed<class_InputEventJoypadButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
  22. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_pressure<class_InputEventJoypadButton_set_pressure>` **(** :ref:`float<class_float>` pressure **)** |
  24. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  25. Member Variables
  26. ----------------
  27. - :ref:`int<class_int>` **button_index** - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope].
  28. - :ref:`bool<class_bool>` **pressed** - Pressed state of the joypad button.
  29. - :ref:`float<class_float>` **pressure** - Intensity of the button pressure, ranges from 0 to 1.0.
  30. Member Function Description
  31. ---------------------------
  32. .. _class_InputEventJoypadButton_get_button_index:
  33. - :ref:`int<class_int>` **get_button_index** **(** **)** const
  34. .. _class_InputEventJoypadButton_get_pressure:
  35. - :ref:`float<class_float>` **get_pressure** **(** **)** const
  36. .. _class_InputEventJoypadButton_set_button_index:
  37. - void **set_button_index** **(** :ref:`int<class_int>` button_index **)**
  38. .. _class_InputEventJoypadButton_set_pressed:
  39. - void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
  40. .. _class_InputEventJoypadButton_set_pressure:
  41. - void **set_pressure** **(** :ref:`float<class_float>` pressure **)**