class_inputeventjoypadmotion.rst 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the InputEventJoypadMotion.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_InputEventJoypadMotion:
  5. InputEventJoypadMotion
  6. ======================
  7. **Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Input event type for joypad motion/axis events.
  12. Member Functions
  13. ----------------
  14. +----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`get_axis<class_InputEventJoypadMotion_get_axis>` **(** **)** const |
  16. +----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`get_axis_value<class_InputEventJoypadMotion_get_axis_value>` **(** **)** const |
  18. +----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_axis<class_InputEventJoypadMotion_set_axis>` **(** :ref:`int<class_int>` axis **)** |
  20. +----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_axis_value<class_InputEventJoypadMotion_set_axis_value>` **(** :ref:`float<class_float>` axis_value **)** |
  22. +----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  23. Member Variables
  24. ----------------
  25. - :ref:`int<class_int>` **axis** - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope].
  26. - :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.
  27. Member Function Description
  28. ---------------------------
  29. .. _class_InputEventJoypadMotion_get_axis:
  30. - :ref:`int<class_int>` **get_axis** **(** **)** const
  31. .. _class_InputEventJoypadMotion_get_axis_value:
  32. - :ref:`float<class_float>` **get_axis_value** **(** **)** const
  33. .. _class_InputEventJoypadMotion_set_axis:
  34. - void **set_axis** **(** :ref:`int<class_int>` axis **)**
  35. .. _class_InputEventJoypadMotion_set_axis_value:
  36. - void **set_axis_value** **(** :ref:`float<class_float>` axis_value **)**