class_sliderjoint.rst 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the SliderJoint.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_SliderJoint:
  5. SliderJoint
  6. ===========
  7. **Inherits:** :ref:`Joint<class_joint>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_param<class_SliderJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
  15. +----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_param<class_SliderJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
  17. +----------------------------+--------------------------------------------------------------------------------------------------------------------------+
  18. Member Variables
  19. ----------------
  20. - :ref:`float<class_float>` **angular_limit/damping**
  21. - :ref:`float<class_float>` **angular_limit/lower_angle**
  22. - :ref:`float<class_float>` **angular_limit/restitution**
  23. - :ref:`float<class_float>` **angular_limit/softness**
  24. - :ref:`float<class_float>` **angular_limit/upper_angle**
  25. - :ref:`float<class_float>` **angular_motion/damping**
  26. - :ref:`float<class_float>` **angular_motion/restitution**
  27. - :ref:`float<class_float>` **angular_motion/softness**
  28. - :ref:`float<class_float>` **angular_ortho/damping**
  29. - :ref:`float<class_float>` **angular_ortho/restitution**
  30. - :ref:`float<class_float>` **angular_ortho/softness**
  31. - :ref:`float<class_float>` **linear_limit/damping**
  32. - :ref:`float<class_float>` **linear_limit/lower_distance**
  33. - :ref:`float<class_float>` **linear_limit/restitution**
  34. - :ref:`float<class_float>` **linear_limit/softness**
  35. - :ref:`float<class_float>` **linear_limit/upper_distance**
  36. - :ref:`float<class_float>` **linear_motion/damping**
  37. - :ref:`float<class_float>` **linear_motion/restitution**
  38. - :ref:`float<class_float>` **linear_motion/softness**
  39. - :ref:`float<class_float>` **linear_ortho/damping**
  40. - :ref:`float<class_float>` **linear_ortho/restitution**
  41. - :ref:`float<class_float>` **linear_ortho/softness**
  42. Numeric Constants
  43. -----------------
  44. - **PARAM_LINEAR_LIMIT_UPPER** = **0**
  45. - **PARAM_LINEAR_LIMIT_LOWER** = **1**
  46. - **PARAM_LINEAR_LIMIT_SOFTNESS** = **2**
  47. - **PARAM_LINEAR_LIMIT_RESTITUTION** = **3**
  48. - **PARAM_LINEAR_LIMIT_DAMPING** = **4**
  49. - **PARAM_LINEAR_MOTION_SOFTNESS** = **5**
  50. - **PARAM_LINEAR_MOTION_RESTITUTION** = **6**
  51. - **PARAM_LINEAR_MOTION_DAMPING** = **7**
  52. - **PARAM_LINEAR_ORTHOGONAL_SOFTNESS** = **8**
  53. - **PARAM_LINEAR_ORTHOGONAL_RESTITUTION** = **9**
  54. - **PARAM_LINEAR_ORTHOGONAL_DAMPING** = **10**
  55. - **PARAM_ANGULAR_LIMIT_UPPER** = **11**
  56. - **PARAM_ANGULAR_LIMIT_LOWER** = **12**
  57. - **PARAM_ANGULAR_LIMIT_SOFTNESS** = **13**
  58. - **PARAM_ANGULAR_LIMIT_RESTITUTION** = **14**
  59. - **PARAM_ANGULAR_LIMIT_DAMPING** = **15**
  60. - **PARAM_ANGULAR_MOTION_SOFTNESS** = **16**
  61. - **PARAM_ANGULAR_MOTION_RESTITUTION** = **17**
  62. - **PARAM_ANGULAR_MOTION_DAMPING** = **18**
  63. - **PARAM_ANGULAR_ORTHOGONAL_SOFTNESS** = **19**
  64. - **PARAM_ANGULAR_ORTHOGONAL_RESTITUTION** = **20**
  65. - **PARAM_ANGULAR_ORTHOGONAL_DAMPING** = **21**
  66. - **PARAM_MAX** = **22**
  67. Member Function Description
  68. ---------------------------
  69. .. _class_SliderJoint_get_param:
  70. - :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
  71. .. _class_SliderJoint_set_param:
  72. - void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**