godot-docs/classes/class_inputeventjoypadmotion.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/InputEventJoypadMotion.xml.

.. _class_InputEventJoypadMotion:

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

**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

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

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

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

Tutorials
---------

- :doc:`InputEvent <../tutorials/inputs/inputevent>`

Properties
----------

+-------------------------------------------+---------------------------------------------------------------------+---------+
| :ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` | :ref:`axis<class_InputEventJoypadMotion_property_axis>`             | ``0``   |
+-------------------------------------------+---------------------------------------------------------------------+---------+
| :ref:`float<class_float>`                 | :ref:`axis_value<class_InputEventJoypadMotion_property_axis_value>` | ``0.0`` |
+-------------------------------------------+---------------------------------------------------------------------+---------+

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

.. _class_InputEventJoypadMotion_property_axis:

- :ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **axis**

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

Axis identifier. Use one of the :ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` 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.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`