Joint.xml 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Joint" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Base class for all 3D joints
  5. </brief_description>
  6. <description>
  7. 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
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_exclude_nodes_from_collision" qualifiers="const">
  15. <return type="bool">
  16. </return>
  17. <description>
  18. </description>
  19. </method>
  20. <method name="get_node_a" qualifiers="const">
  21. <return type="NodePath">
  22. </return>
  23. <description>
  24. </description>
  25. </method>
  26. <method name="get_node_b" qualifiers="const">
  27. <return type="NodePath">
  28. </return>
  29. <description>
  30. </description>
  31. </method>
  32. <method name="get_solver_priority" qualifiers="const">
  33. <return type="int">
  34. </return>
  35. <description>
  36. </description>
  37. </method>
  38. <method name="set_exclude_nodes_from_collision">
  39. <return type="void">
  40. </return>
  41. <argument index="0" name="enable" type="bool">
  42. </argument>
  43. <description>
  44. </description>
  45. </method>
  46. <method name="set_node_a">
  47. <return type="void">
  48. </return>
  49. <argument index="0" name="node" type="NodePath">
  50. </argument>
  51. <description>
  52. </description>
  53. </method>
  54. <method name="set_node_b">
  55. <return type="void">
  56. </return>
  57. <argument index="0" name="node" type="NodePath">
  58. </argument>
  59. <description>
  60. </description>
  61. </method>
  62. <method name="set_solver_priority">
  63. <return type="void">
  64. </return>
  65. <argument index="0" name="priority" type="int">
  66. </argument>
  67. <description>
  68. </description>
  69. </method>
  70. </methods>
  71. <members>
  72. <member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision">
  73. If [code]true[/code] the two bodies of the nodes are not able to collide with each other.
  74. </member>
  75. <member name="nodes/node_a" type="NodePath" setter="set_node_a" getter="get_node_a">
  76. The [Node], the first side of the Joint attaches to.
  77. </member>
  78. <member name="nodes/node_b" type="NodePath" setter="set_node_b" getter="get_node_b">
  79. The [Node], the second side of the Joint attaches to.
  80. </member>
  81. <member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority">
  82. The order in wich the solver is executed compared to the other [Joints], the lower, the earlier.
  83. </member>
  84. </members>
  85. <constants>
  86. </constants>
  87. </class>