Files
godot-docs/classes/class_concavepolygonshape2d.rst
2019-01-07 10:14:12 +01:00

48 lines
2.0 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ConcavePolygonShape2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ConcavePolygonShape2D:
ConcavePolygonShape2D
=====================
**Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Concave polygon 2D shape resource for physics.
Properties
----------
+-------------------------------------------------+----------------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` |
+-------------------------------------------------+----------------------------------------------------------------+
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 :ref:`RigidBody2D<class_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 :ref:`ConvexPolygonShape2D<class_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.
Property Descriptions
---------------------
.. _class_ConcavePolygonShape2D_property_segments:
- :ref:`PoolVector2Array<class_PoolVector2Array>` **segments**
+----------+---------------------+
| *Setter* | set_segments(value) |
+----------+---------------------+
| *Getter* | get_segments() |
+----------+---------------------+
The array of points that make up the ``ConcavePolygonShape2D``'s line segments.