CollisionPolygon.xml 1.5 KB

123456789101112131415161718192021222324252627
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CollisionPolygon" inherits="Spatial" version="3.2">
  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 run-time. Creates a [Shape] for gameplay. Properties modified during gameplay will have no effect.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. </methods>
  13. <members>
  14. <member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">
  15. Length that the resulting collision extends in either direction perpendicular to its polygon.
  16. </member>
  17. <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
  18. If [code]true[/code], no collision will be produced.
  19. </member>
  20. <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
  21. Array of vertices which define the polygon.
  22. [b]Note:[/b] The returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member.
  23. </member>
  24. </members>
  25. <constants>
  26. </constants>
  27. </class>