CollisionPolygon.xml 2.0 KB

1234567891011121314151617181920212223242526272829303132
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CollisionPolygon" inherits="Spatial" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  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. [b]Warning:[/b] A non-uniformly scaled CollisionPolygon3D node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change its [member polygon]'s vertices instead.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. </methods>
  14. <members>
  15. <member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">
  16. Length that the resulting collision extends in either direction perpendicular to its polygon.
  17. </member>
  18. <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
  19. If [code]true[/code], no collision will be produced.
  20. </member>
  21. <member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
  22. The collision margin for the generated [Shape]. See [member Shape.margin] for more details.
  23. </member>
  24. <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
  25. Array of vertices which define the polygon.
  26. [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.
  27. </member>
  28. </members>
  29. <constants>
  30. </constants>
  31. </class>