godot-docs/classes/class_occluderpolygon2d.rst

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

.. _class_OccluderPolygon2D:

OccluderPolygon2D
=================

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

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

Defines a 2D polygon for LightOccluder2D.

Properties
----------

+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`bool<class_bool>`                          | :ref:`closed<class_OccluderPolygon2D_property_closed>`       |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`CullMode<enum_OccluderPolygon2D_CullMode>` | :ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>` |
+--------------------------------------------------+--------------------------------------------------------------+
| :ref:`PoolVector2Array<class_PoolVector2Array>`  | :ref:`polygon<class_OccluderPolygon2D_property_polygon>`     |
+--------------------------------------------------+--------------------------------------------------------------+

Enumerations
------------

.. _enum_OccluderPolygon2D_CullMode:

.. _class_OccluderPolygon2D_constant_CULL_DISABLED:

.. _class_OccluderPolygon2D_constant_CULL_CLOCKWISE:

.. _class_OccluderPolygon2D_constant_CULL_COUNTER_CLOCKWISE:

enum **CullMode**:

- **CULL_DISABLED** = **0** --- Culling mode for the occlusion. Disabled means no culling. See :ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>`.

- **CULL_CLOCKWISE** = **1** --- Culling mode for the occlusion. Sets the culling to be in clockwise direction. See :ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>`.

- **CULL_COUNTER_CLOCKWISE** = **2** --- Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See :ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>`.

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

Editor facility that helps you draw a 2D polygon used as resource for :ref:`LightOccluder2D<class_LightOccluder2D>`.

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

.. _class_OccluderPolygon2D_property_closed:

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

+----------+-------------------+
| *Setter* | set_closed(value) |
+----------+-------------------+
| *Getter* | is_closed()       |
+----------+-------------------+

If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value ``true``.

.. _class_OccluderPolygon2D_property_cull_mode:

- :ref:`CullMode<enum_OccluderPolygon2D_CullMode>` **cull_mode**

+----------+----------------------+
| *Setter* | set_cull_mode(value) |
+----------+----------------------+
| *Getter* | get_cull_mode()      |
+----------+----------------------+

Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``.

.. _class_OccluderPolygon2D_property_polygon:

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

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

A :ref:`Vector2<class_Vector2>` array with the index for polygon's vertices positions. Note that the returned value is a copy of the underlying array, rather than a reference.