:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the InputEventJoypadMotion.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_InputEventJoypadMotion:

InputEventJoypadMotion
======================

**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Input event type for gamepad joysticks and other motions. For buttons, see ``InputEventJoypadButton``.

Properties
----------

+---------------------------+---------------------------------------------------------------------+-----+
| :ref:`int<class_int>`     | :ref:`axis<class_InputEventJoypadMotion_property_axis>`             | 0   |
+---------------------------+---------------------------------------------------------------------+-----+
| :ref:`float<class_float>` | :ref:`axis_value<class_InputEventJoypadMotion_property_axis_value>` | 0.0 |
+---------------------------+---------------------------------------------------------------------+-----+

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

Stores information about joystick motions. One ``InputEventJoypadMotion`` represents one axis at a time.

Tutorials
---------

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

Property Descriptions
---------------------

.. _class_InputEventJoypadMotion_property_axis:

- :ref:`int<class_int>` **axis**

+-----------+-----------------+
| *Default* | 0               |
+-----------+-----------------+
| *Setter*  | set_axis(value) |
+-----------+-----------------+
| *Getter*  | get_axis()      |
+-----------+-----------------+

Axis identifier. Use one of the :ref:`JoystickList<enum_@GlobalScope_JoystickList>` axis constants.

.. _class_InputEventJoypadMotion_property_axis_value:

- :ref:`float<class_float>` **axis_value**

+-----------+-----------------------+
| *Default* | 0.0                   |
+-----------+-----------------------+
| *Setter*  | set_axis_value(value) |
+-----------+-----------------------+
| *Getter*  | get_axis_value()      |
+-----------+-----------------------+

Current position of the joystick on the given axis. The value ranges from ``-1.0`` to ``1.0``. A value of ``0`` means the axis is in its resting position.