CollisionShape.xml 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CollisionShape" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Node that represents collision shape data in 3D space.
  5. </brief_description>
  6. <description>
  7. Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area] to give it a detection shape, or add it to a [PhysicsBody] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_shape" qualifiers="const">
  15. <return type="Shape">
  16. </return>
  17. <description>
  18. </description>
  19. </method>
  20. <method name="is_disabled" qualifiers="const">
  21. <return type="bool">
  22. </return>
  23. <description>
  24. </description>
  25. </method>
  26. <method name="make_convex_from_brothers">
  27. <return type="void">
  28. </return>
  29. <description>
  30. Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry.
  31. </description>
  32. </method>
  33. <method name="resource_changed">
  34. <return type="void">
  35. </return>
  36. <argument index="0" name="resource" type="Resource">
  37. </argument>
  38. <description>
  39. If this method exists within a script it will be called whenever the shape resource has been modified.
  40. </description>
  41. </method>
  42. <method name="set_disabled">
  43. <return type="void">
  44. </return>
  45. <argument index="0" name="enable" type="bool">
  46. </argument>
  47. <description>
  48. </description>
  49. </method>
  50. <method name="set_shape">
  51. <return type="void">
  52. </return>
  53. <argument index="0" name="shape" type="Shape">
  54. </argument>
  55. <description>
  56. </description>
  57. </method>
  58. </methods>
  59. <members>
  60. <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
  61. A disabled collision shape has no effect in the world.
  62. </member>
  63. <member name="shape" type="Shape" setter="set_shape" getter="get_shape">
  64. The actual shape owned by this collision shape.
  65. </member>
  66. </members>
  67. <constants>
  68. </constants>
  69. </class>