CollisionPolygon.xml 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
  3. <brief_description>
  4. Editor-only class for defining a collision polygon in 3D space.
  5. </brief_description>
  6. <description>
  7. Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a [Shape] for gameplay. Properties modified during gameplay will have no effect.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_depth" qualifiers="const">
  15. <return type="float">
  16. </return>
  17. <description>
  18. </description>
  19. </method>
  20. <method name="get_polygon" qualifiers="const">
  21. <return type="PoolVector2Array">
  22. </return>
  23. <description>
  24. </description>
  25. </method>
  26. <method name="is_disabled" qualifiers="const">
  27. <return type="bool">
  28. </return>
  29. <description>
  30. </description>
  31. </method>
  32. <method name="set_depth">
  33. <return type="void">
  34. </return>
  35. <argument index="0" name="depth" type="float">
  36. </argument>
  37. <description>
  38. </description>
  39. </method>
  40. <method name="set_disabled">
  41. <return type="void">
  42. </return>
  43. <argument index="0" name="disabled" type="bool">
  44. </argument>
  45. <description>
  46. </description>
  47. </method>
  48. <method name="set_polygon">
  49. <return type="void">
  50. </return>
  51. <argument index="0" name="polygon" type="PoolVector2Array">
  52. </argument>
  53. <description>
  54. </description>
  55. </method>
  56. </methods>
  57. <members>
  58. <member name="depth" type="float" setter="set_depth" getter="get_depth">
  59. Length that the resulting collision extends in either direction perpendicular to its polygon.
  60. </member>
  61. <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
  62. If true, no collision will be produced.
  63. </member>
  64. <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon">
  65. Array of vertices which define the polygon.
  66. </member>
  67. </members>
  68. <constants>
  69. </constants>
  70. </class>