class_occluderpolygon2d.rst

github_url:	hide

OccluderPolygon2D

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

Defines a 2D polygon for LightOccluder2D.

Description

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

Properties

:ref:`bool<class_bool>`	:ref:`closed<class_OccluderPolygon2D_property_closed>`	true
:ref:`CullMode<enum_OccluderPolygon2D_CullMode>`	:ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>`	0
:ref:`PackedVector2Array<class_PackedVector2Array>`	:ref:`polygon<class_OccluderPolygon2D_property_polygon>`	PackedVector2Array( )

Enumerations

enum CullMode:

• CULL_DISABLED = 0 --- Culling is disabled. See :ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>`.
• CULL_CLOCKWISE = 1 --- Culling is performed in the clockwise direction. See :ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>`.
• CULL_COUNTER_CLOCKWISE = 2 --- Culling is performed in the counterclockwise direction. See :ref:`cull_mode<class_OccluderPolygon2D_property_cull_mode>`.

Property Descriptions

• :ref:`bool<class_bool>` closed

Default	true
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.

---

• :ref:`CullMode<enum_OccluderPolygon2D_CullMode>` cull_mode

Default	0
Setter	set_cull_mode(value)
Getter	get_cull_mode()

The culling mode to use.

---

• :ref:`PackedVector2Array<class_PackedVector2Array>` polygon

Default	PackedVector2Array( )
Setter	set_polygon(value)
Getter	get_polygon()

A :ref:`Vector2<class_Vector2>` array with the index for polygon's vertices positions.

Note: The returned value is a copy of the underlying array, rather than a reference.