:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CollisionPolygon.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_CollisionPolygon:

CollisionPolygon
================

**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Editor-only class for defining a collision polygon in 3D space.

Properties
----------

+-------------------------------------------------+-----------------------------------------------------------+
| :ref:`float<class_float>`                       | :ref:`depth<class_CollisionPolygon_property_depth>`       |
+-------------------------------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>`                         | :ref:`disabled<class_CollisionPolygon_property_disabled>` |
+-------------------------------------------------+-----------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>`   |
+-------------------------------------------------+-----------------------------------------------------------+

Description
-----------

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 runtime. Creates a :ref:`Shape<class_Shape>` for gameplay. Properties modified during gameplay will have no effect.

Property Descriptions
---------------------

.. _class_CollisionPolygon_property_depth:

- :ref:`float<class_float>` **depth**

+----------+------------------+
| *Setter* | set_depth(value) |
+----------+------------------+
| *Getter* | get_depth()      |
+----------+------------------+

Length that the resulting collision extends in either direction perpendicular to its polygon.

----

.. _class_CollisionPolygon_property_disabled:

- :ref:`bool<class_bool>` **disabled**

+----------+---------------------+
| *Setter* | set_disabled(value) |
+----------+---------------------+
| *Getter* | is_disabled()       |
+----------+---------------------+

If ``true``, no collision will be produced.

----

.. _class_CollisionPolygon_property_polygon:

- :ref:`PoolVector2Array<class_PoolVector2Array>` **polygon**

+----------+--------------------+
| *Setter* | set_polygon(value) |
+----------+--------------------+
| *Getter* | get_polygon()      |
+----------+--------------------+

Array of vertices which define the polygon. Note that 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 ``polygon`` member.