godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
classes/class_inputeventjoypadmotion.rst
View File

@@ -14,55 +14,70 @@ InputEventJoypadMotion
Input event type for gamepad joysticks and other motions. For buttons, see ``InputEventJoypadButton``.
.. rst-class:: classref-introduction-group
Description
-----------
Stores information about joystick motions. One ``InputEventJoypadMotion`` represents one axis at a time.
Stores information about joystick motions. One **InputEventJoypadMotion** represents one axis at a time.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`InputEvent <../tutorials/inputs/inputevent>`
.. rst-class:: classref-reftable-group
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`` |
+-------------------------------------------+---------------------------------------------------------------------+---------+
.. table::
:widths: auto
+-------------------------------------------+---------------------------------------------------------------------+---------+
| :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`` |
+-------------------------------------------+---------------------------------------------------------------------+---------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_InputEventJoypadMotion_property_axis:
- :ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **axis**
.. rst-class:: classref-property
+-----------+-----------------+
| *Default* | ``0`` |
+-----------+-----------------+
| *Setter* | set_axis(value) |
+-----------+-----------------+
| *Getter* | get_axis() |
+-----------+-----------------+
:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **axis** = ``0``
.. rst-class:: classref-property-setget
- void **set_axis** **(** :ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` value **)**
- :ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **get_axis** **(** **)**
Axis identifier. Use one of the :ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` axis constants.
.. rst-class:: classref-item-separator
----
.. _class_InputEventJoypadMotion_property_axis_value:
- :ref:`float<class_float>` **axis_value**
.. rst-class:: classref-property
+-----------+-----------------------+
| *Default* | ``0.0`` |
+-----------+-----------------------+
| *Setter* | set_axis_value(value) |
+-----------+-----------------------+
| *Getter* | get_axis_value() |
+-----------+-----------------------+
:ref:`float<class_float>` **axis_value** = ``0.0``
.. rst-class:: classref-property-setget
- void **set_axis_value** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **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.