class_pinjoint.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the PinJoint.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_PinJoint:
  5. PinJoint
  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_PinJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
  15. +----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_param<class_PinJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
  17. +----------------------------+-----------------------------------------------------------------------------------------------------------------------+
  18. Member Variables
  19. ----------------
  20. - :ref:`float<class_float>` **params/bias**
  21. - :ref:`float<class_float>` **params/damping**
  22. - :ref:`float<class_float>` **params/impulse_clamp**
  23. Numeric Constants
  24. -----------------
  25. - **PARAM_BIAS** = **0**
  26. - **PARAM_DAMPING** = **1**
  27. - **PARAM_IMPULSE_CLAMP** = **2**
  28. Member Function Description
  29. ---------------------------
  30. .. _class_PinJoint_get_param:
  31. - :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
  32. .. _class_PinJoint_set_param:
  33. - void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**