class_inputeventjoypadbutton.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  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 for gamepad buttons.
  12. Member Variables
  13. ----------------
  14. .. _class_InputEventJoypadButton_button_index:
  15. - :ref:`int<class_int>` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from @global Scope.
  16. .. _class_InputEventJoypadButton_pressed:
  17. - :ref:`bool<class_bool>` **pressed** - If ``true`` the button's state is pressed. If ``false`` the button's state is released.
  18. .. _class_InputEventJoypadButton_pressure:
  19. - :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``.
  20. Description
  21. -----------
  22. Input event type for gamepad buttons. For joysticks see :ref:`InputEventJoypadMotion<class_inputeventjoypadmotion>`.