OccluderPolygon2D

Inherits: Resource < RefCounted < Object

Defines a 2D polygon for LightOccluder2D.

Description

Editor facility that helps you draw a 2D polygon used as resource for LightOccluder2D.

Properties

Enumerations

enum CullMode:

CullMode CULL_DISABLED = 0

Culling is disabled. See cull_mode.

CullMode CULL_CLOCKWISE = 1

Culling is performed in the clockwise direction. See cull_mode.

CullMode CULL_COUNTER_CLOCKWISE = 2

Culling is performed in the counterclockwise direction. See cull_mode.

Property Descriptions

bool closed = true

• void set_closed ( bool value )

• bool 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.

CullMode cull_mode = 0

• void set_cull_mode ( CullMode value )

• CullMode get_cull_mode ( )

The culling mode to use.

PackedVector2Array polygon = PackedVector2Array()

• void set_polygon ( PackedVector2Array value )

• PackedVector2Array get_polygon ( )

A 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.

Previous Next

© Copyright 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision 53e837c6.

Built with Sphinx using a theme provided by Read the Docs.