| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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>`
- Input event for gamepad buttons.
- Description
- -----------
- Input event type for gamepad buttons. For gamepad analog sticks and joysticks, see :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>`.
- Tutorials
- ---------
- - :doc:`../tutorials/inputs/inputevent`
- Properties
- ----------
- +---------------------------+-------------------------------------------------------------------------+-----------+
- | :ref:`int<class_int>` | :ref:`button_index<class_InputEventJoypadButton_property_button_index>` | ``0`` |
- +---------------------------+-------------------------------------------------------------------------+-----------+
- | :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventJoypadButton_property_pressed>` | ``false`` |
- +---------------------------+-------------------------------------------------------------------------+-----------+
- | :ref:`float<class_float>` | :ref:`pressure<class_InputEventJoypadButton_property_pressure>` | ``0.0`` |
- +---------------------------+-------------------------------------------------------------------------+-----------+
- Property Descriptions
- ---------------------
- .. _class_InputEventJoypadButton_property_button_index:
- - :ref:`int<class_int>` **button_index**
- +-----------+-------------------------+
- | *Default* | ``0`` |
- +-----------+-------------------------+
- | *Setter* | set_button_index(value) |
- +-----------+-------------------------+
- | *Getter* | get_button_index() |
- +-----------+-------------------------+
- Button identifier. One of the :ref:`JoystickList<enum_@GlobalScope_JoystickList>` button constants.
- ----
- .. _class_InputEventJoypadButton_property_pressed:
- - :ref:`bool<class_bool>` **pressed**
- +-----------+--------------------+
- | *Default* | ``false`` |
- +-----------+--------------------+
- | *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**
- +-----------+---------------------+
- | *Default* | ``0.0`` |
- +-----------+---------------------+
- | *Setter* | set_pressure(value) |
- +-----------+---------------------+
- | *Getter* | get_pressure() |
- +-----------+---------------------+
- Represents the pressure the user puts on the button with their finger, if the controller supports it. Ranges from ``0`` to ``1``.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
