class_joint.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Joint.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Joint:
  5. Joint
  6. =====
  7. **Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Inherited By:** :ref:`ConeTwistJoint<class_conetwistjoint>`, :ref:`Generic6DOFJoint<class_generic6dofjoint>`, :ref:`SliderJoint<class_sliderjoint>`, :ref:`HingeJoint<class_hingejoint>`, :ref:`PinJoint<class_pinjoint>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for all 3D joints
  13. Member Variables
  14. ----------------
  15. .. _class_Joint_collision/exclude_nodes:
  16. - :ref:`bool<class_bool>` **collision/exclude_nodes** - If ``true`` the two bodies of the nodes are not able to collide with each other.
  17. .. _class_Joint_nodes/node_a:
  18. - :ref:`NodePath<class_nodepath>` **nodes/node_a** - The :ref:`Node<class_node>`, the first side of the Joint attaches to.
  19. .. _class_Joint_nodes/node_b:
  20. - :ref:`NodePath<class_nodepath>` **nodes/node_b** - The :ref:`Node<class_node>`, the second side of the Joint attaches to.
  21. .. _class_Joint_solver/priority:
  22. - :ref:`int<class_int>` **solver/priority** - The order in which the solver is executed compared to the other Joints, the lower, the earlier.
  23. Description
  24. -----------
  25. All 3D joints link two nodes, has a priority, and can decide if the two bodies of the nodes should be able to collide with each other