summaryrefslogtreecommitdiff
path: root/doc/classes/ConcavePolygonShape2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ConcavePolygonShape2D.xml')
-rw-r--r--doc/classes/ConcavePolygonShape2D.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/classes/ConcavePolygonShape2D.xml b/doc/classes/ConcavePolygonShape2D.xml
new file mode 100644
index 0000000000..018d64b643
--- /dev/null
+++ b/doc/classes/ConcavePolygonShape2D.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Concave polygon 2D shape resource for physics.
+ </brief_description>
+ <description>
+ Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really 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.
+ 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.
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_segments" qualifiers="const">
+ <return type="PoolVector2Array">
+ </return>
+ <description>
+ Return the array of segments.
+ </description>
+ </method>
+ <method name="set_segments">
+ <return type="void">
+ </return>
+ <argument index="0" name="segments" type="PoolVector2Array">
+ </argument>
+ <description>
+ Set the array of segments.
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="segments" type="PoolVector2Array" setter="set_segments" getter="get_segments">
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>