Files
godot-docs/classes/class_inputeventjoypadmotion.rst
2017-06-17 11:32:15 +02:00

57 lines
2.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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 joypad motion/axis events.
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_axis<class_InputEventJoypadMotion_get_axis>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_axis_value<class_InputEventJoypadMotion_get_axis_value>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis<class_InputEventJoypadMotion_set_axis>` **(** :ref:`int<class_int>` axis **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_axis_value<class_InputEventJoypadMotion_set_axis_value>` **(** :ref:`float<class_float>` axis_value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`int<class_int>` **axis** - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope].
- :ref:`float<class_float>` **axis_value** - Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position.
Member Function Description
---------------------------
.. _class_InputEventJoypadMotion_get_axis:
- :ref:`int<class_int>` **get_axis** **(** **)** const
.. _class_InputEventJoypadMotion_get_axis_value:
- :ref:`float<class_float>` **get_axis_value** **(** **)** const
.. _class_InputEventJoypadMotion_set_axis:
- void **set_axis** **(** :ref:`int<class_int>` axis **)**
.. _class_InputEventJoypadMotion_set_axis_value:
- void **set_axis_value** **(** :ref:`float<class_float>` axis_value **)**