class_joint.rst 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Joint.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Joint:
  6. Joint
  7. =====
  8. **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`ConeTwistJoint<class_ConeTwistJoint>`, :ref:`Generic6DOFJoint<class_Generic6DOFJoint>`, :ref:`HingeJoint<class_HingeJoint>`, :ref:`PinJoint<class_PinJoint>`, :ref:`SliderJoint<class_SliderJoint>`
  10. **Category:** Core
  11. Brief Description
  12. -----------------
  13. Base class for all 3D joints
  14. Properties
  15. ----------
  16. +---------------------------------+------------------------------------------------------------------------------+
  17. | :ref:`bool<class_bool>` | :ref:`collision/exclude_nodes<class_Joint_property_collision/exclude_nodes>` |
  18. +---------------------------------+------------------------------------------------------------------------------+
  19. | :ref:`NodePath<class_NodePath>` | :ref:`nodes/node_a<class_Joint_property_nodes/node_a>` |
  20. +---------------------------------+------------------------------------------------------------------------------+
  21. | :ref:`NodePath<class_NodePath>` | :ref:`nodes/node_b<class_Joint_property_nodes/node_b>` |
  22. +---------------------------------+------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`solver/priority<class_Joint_property_solver/priority>` |
  24. +---------------------------------+------------------------------------------------------------------------------+
  25. Description
  26. -----------
  27. Joints are used to bind together two physics bodies. They have a solver priority and can define if the bodies of the two attached nodes should be able to collide with each other.
  28. Property Descriptions
  29. ---------------------
  30. .. _class_Joint_property_collision/exclude_nodes:
  31. - :ref:`bool<class_bool>` **collision/exclude_nodes**
  32. +----------+-----------------------------------------+
  33. | *Setter* | set_exclude_nodes_from_collision(value) |
  34. +----------+-----------------------------------------+
  35. | *Getter* | get_exclude_nodes_from_collision() |
  36. +----------+-----------------------------------------+
  37. If ``true``, the two bodies of the nodes are not able to collide with each other.
  38. ----
  39. .. _class_Joint_property_nodes/node_a:
  40. - :ref:`NodePath<class_NodePath>` **nodes/node_a**
  41. +----------+-------------------+
  42. | *Setter* | set_node_a(value) |
  43. +----------+-------------------+
  44. | *Getter* | get_node_a() |
  45. +----------+-------------------+
  46. The node attached to the first side (A) of the joint.
  47. ----
  48. .. _class_Joint_property_nodes/node_b:
  49. - :ref:`NodePath<class_NodePath>` **nodes/node_b**
  50. +----------+-------------------+
  51. | *Setter* | set_node_b(value) |
  52. +----------+-------------------+
  53. | *Getter* | get_node_b() |
  54. +----------+-------------------+
  55. The node attached to the second side (B) of the joint.
  56. ----
  57. .. _class_Joint_property_solver/priority:
  58. - :ref:`int<class_int>` **solver/priority**
  59. +----------+----------------------------+
  60. | *Setter* | set_solver_priority(value) |
  61. +----------+----------------------------+
  62. | *Getter* | get_solver_priority() |
  63. +----------+----------------------------+
  64. The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority.