ConcavePolygonShape2D.xml 1.5 KB

1234567891011121314151617181920212223
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="ConcavePolygonShape2D" inherits="Shape2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Concave polygon 2D shape resource for physics.
  5. </brief_description>
  6. <description>
  7. Concave polygon 2D shape resource for physics. It is made out of segments and is optimal for complex polygonal concave collisions. However, it is not advised to use for [RigidBody2D] nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions.
  8. The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
  9. [b]Warning:[/b] Using this shape for an [Area2D] (via a [CollisionShape2D] node) may give unexpected results: the area will only detect collisions with the segments in the [ConcavePolygonShape2D] (and not with any "inside" of the shape, for example).
  10. </description>
  11. <tutorials>
  12. </tutorials>
  13. <methods>
  14. </methods>
  15. <members>
  16. <member name="segments" type="PoolVector2Array" setter="set_segments" getter="get_segments" default="PoolVector2Array( )">
  17. The array of points that make up the [ConcavePolygonShape2D]'s line segments.
  18. </member>
  19. </members>
  20. <constants>
  21. </constants>
  22. </class>