class_hingejoint.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_HingeJoint:
  4. HingeJoint
  5. ==========
  6. **Inherits:** :ref:`Joint<class_joint>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`bool<class_bool>` | :ref:`get_flag<class_HingeJoint_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
  14. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_param<class_HingeJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
  16. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_flag<class_HingeJoint_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)** |
  18. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_param<class_HingeJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
  20. +----------------------------+-------------------------------------------------------------------------------------------------------------------------+
  21. Numeric Constants
  22. -----------------
  23. - **PARAM_BIAS** = **0**
  24. - **PARAM_LIMIT_UPPER** = **1**
  25. - **PARAM_LIMIT_LOWER** = **2**
  26. - **PARAM_LIMIT_BIAS** = **3**
  27. - **PARAM_LIMIT_SOFTNESS** = **4**
  28. - **PARAM_LIMIT_RELAXATION** = **5**
  29. - **PARAM_MOTOR_TARGET_VELOCITY** = **6**
  30. - **PARAM_MOTOR_MAX_IMPULSE** = **7**
  31. - **PARAM_MAX** = **8**
  32. - **FLAG_USE_LIMIT** = **0**
  33. - **FLAG_ENABLE_MOTOR** = **1**
  34. - **FLAG_MAX** = **2**
  35. Member Function Description
  36. ---------------------------
  37. .. _class_HingeJoint_get_flag:
  38. - :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
  39. .. _class_HingeJoint_get_param:
  40. - :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
  41. .. _class_HingeJoint_set_flag:
  42. - void **set_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)**
  43. .. _class_HingeJoint_set_param:
  44. - void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**