godot-docs/classes/class_collisionpolygon.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CollisionPolygon.xml.

.. _class_CollisionPolygon:

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

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

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

.. rst-class:: classref-introduction-group

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

\ **Warning:** 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 :ref:`polygon<class_CollisionPolygon_property_polygon>`'s vertices instead.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-------------------------------------------------+-----------------------------------------------------------+--------------------------+
   | :ref:`float<class_float>`                       | :ref:`depth<class_CollisionPolygon_property_depth>`       | ``1.0``                  |
   +-------------------------------------------------+-----------------------------------------------------------+--------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`disabled<class_CollisionPolygon_property_disabled>` | ``false``                |
   +-------------------------------------------------+-----------------------------------------------------------+--------------------------+
   | :ref:`float<class_float>`                       | :ref:`margin<class_CollisionPolygon_property_margin>`     | ``0.04``                 |
   +-------------------------------------------------+-----------------------------------------------------------+--------------------------+
   | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`polygon<class_CollisionPolygon_property_polygon>`   | ``PoolVector2Array(  )`` |
   +-------------------------------------------------+-----------------------------------------------------------+--------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

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

.. _class_CollisionPolygon_property_depth:

.. rst-class:: classref-property

:ref:`float<class_float>` **depth** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_depth** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_depth** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_CollisionPolygon_property_disabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **disabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_disabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_disabled** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_CollisionPolygon_property_margin:

.. rst-class:: classref-property

:ref:`float<class_float>` **margin** = ``0.04``

.. rst-class:: classref-property-setget

- void **set_margin** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_margin** **(** **)**

The collision margin for the generated :ref:`Shape<class_Shape>`. See :ref:`Shape.margin<class_Shape_property_margin>` for more details.

.. rst-class:: classref-item-separator

----

.. _class_CollisionPolygon_property_polygon:

.. rst-class:: classref-property

:ref:`PoolVector2Array<class_PoolVector2Array>` **polygon** = ``PoolVector2Array(  )``

.. rst-class:: classref-property-setget

- void **set_polygon** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` value **)**
- :ref:`PoolVector2Array<class_PoolVector2Array>` **get_polygon** **(** **)**

Array of vertices which define the polygon.

\ **Note:** 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.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`