godot-docs/classes/class_inputeventjoypadbutton.rst

: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>` | 0     |
+---------------------------+-------------------------------------------------------------------------+-------+
| :ref:`bool<class_bool>`   | :ref:`pressed<class_InputEventJoypadButton_property_pressed>`           | false |
+---------------------------+-------------------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`pressure<class_InputEventJoypadButton_property_pressure>`         | 0.0   |
+---------------------------+-------------------------------------------------------------------------+-------+

Description
-----------

Input event type for gamepad buttons. For gamepad analog sticks and joysticks, see :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>`.

Tutorials
---------

- :doc:`../tutorials/inputs/inputevent`

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 his finger, if the controller supports it. Ranges from ``0`` to ``1``.