class_joint.rst 4.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. Member Functions
  13. ----------------
  14. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`bool<class_bool>` | :ref:`get_exclude_nodes_from_collision<class_Joint_get_exclude_nodes_from_collision>` **(** **)** const |
  16. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`NodePath<class_nodepath>` | :ref:`get_node_a<class_Joint_get_node_a>` **(** **)** const |
  18. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`NodePath<class_nodepath>` | :ref:`get_node_b<class_Joint_get_node_b>` **(** **)** const |
  20. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_solver_priority<class_Joint_get_solver_priority>` **(** **)** const |
  22. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_exclude_nodes_from_collision<class_Joint_set_exclude_nodes_from_collision>` **(** :ref:`bool<class_bool>` enable **)** |
  24. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_node_a<class_Joint_set_node_a>` **(** :ref:`NodePath<class_nodepath>` node **)** |
  26. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`set_node_b<class_Joint_set_node_b>` **(** :ref:`NodePath<class_nodepath>` node **)** |
  28. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_solver_priority<class_Joint_set_solver_priority>` **(** :ref:`int<class_int>` priority **)** |
  30. +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
  31. Member Variables
  32. ----------------
  33. - :ref:`bool<class_bool>` **collision/exclude_nodes**
  34. - :ref:`NodePath<class_nodepath>` **nodes/node_a**
  35. - :ref:`NodePath<class_nodepath>` **nodes/node_b**
  36. - :ref:`int<class_int>` **solver/priority**
  37. Member Function Description
  38. ---------------------------
  39. .. _class_Joint_get_exclude_nodes_from_collision:
  40. - :ref:`bool<class_bool>` **get_exclude_nodes_from_collision** **(** **)** const
  41. .. _class_Joint_get_node_a:
  42. - :ref:`NodePath<class_nodepath>` **get_node_a** **(** **)** const
  43. .. _class_Joint_get_node_b:
  44. - :ref:`NodePath<class_nodepath>` **get_node_b** **(** **)** const
  45. .. _class_Joint_get_solver_priority:
  46. - :ref:`int<class_int>` **get_solver_priority** **(** **)** const
  47. .. _class_Joint_set_exclude_nodes_from_collision:
  48. - void **set_exclude_nodes_from_collision** **(** :ref:`bool<class_bool>` enable **)**
  49. .. _class_Joint_set_node_a:
  50. - void **set_node_a** **(** :ref:`NodePath<class_nodepath>` node **)**
  51. .. _class_Joint_set_node_b:
  52. - void **set_node_b** **(** :ref:`NodePath<class_nodepath>` node **)**
  53. .. _class_Joint_set_solver_priority:
  54. - void **set_solver_priority** **(** :ref:`int<class_int>` priority **)**