| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 |
- :github_url: hide
- .. 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.
- Properties
- ----------
- +---------------------------+-------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`button_index<class_InputEventJoypadButton_property_button_index>` |
- +---------------------------+-------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventJoypadButton_property_pressed>` |
- +---------------------------+-------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`pressure<class_InputEventJoypadButton_property_pressure>` |
- +---------------------------+-------------------------------------------------------------------------+
- Description
- -----------
- Input event type for gamepad buttons. For joysticks see :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>`.
- Tutorials
- ---------
- - :doc:`../tutorials/inputs/inputevent`
- Property Descriptions
- ---------------------
- .. _class_InputEventJoypadButton_property_button_index:
- - :ref:`int<class_int>` **button_index**
- +----------+-------------------------+
- | *Setter* | set_button_index(value) |
- +----------+-------------------------+
- | *Getter* | get_button_index() |
- +----------+-------------------------+
- Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope<class_@GlobalScope>`.
- ----
- .. _class_InputEventJoypadButton_property_pressed:
- - :ref:`bool<class_bool>` **pressed**
- +----------+--------------------+
- | *Setter* | set_pressed(value) |
- +----------+--------------------+
- | *Getter* | is_pressed() |
- +----------+--------------------+
- If ``true``, the button's state is pressed. If ``false``, the button's state is released.
- ----
- .. _class_InputEventJoypadButton_property_pressure:
- - :ref:`float<class_float>` **pressure**
- +----------+---------------------+
- | *Setter* | set_pressure(value) |
- +----------+---------------------+
- | *Getter* | get_pressure() |
- +----------+---------------------+
- Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``.
|
