12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 |
- :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>`
- Represents axis motions (such as joystick or analog triggers) from a gamepad.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- Stores information about joystick motions. One **InputEventJoypadMotion** represents one axis at a time. For gamepad buttons, see :ref:`InputEventJoypadButton<class_InputEventJoypadButton>`.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`Using InputEvent <../tutorials/inputs/inputevent>`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. 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:
- .. rst-class:: classref-property
- :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:
- .. rst-class:: classref-property
- :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.
- .. |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.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|