LightOccluder2D¶

Inherits: Node2D < CanvasItem < Node < Object

Occludes light cast by a Light2D, casting shadows.

Description¶

Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an OccluderPolygon2D in order for the shadow to be computed.

Tutorials¶

2D lights and shadows

Properties¶

OccluderPolygon2D	occluder
int	occluder_light_mask	`1`
bool	sdf_collision	`true`

Property Descriptions¶

OccluderPolygon2D occluder

Setter	set_occluder_polygon(value)
Getter	get_occluder_polygon()

The OccluderPolygon2D used to compute the shadow.

int occluder_light_mask

Default	`1`
Setter	set_occluder_light_mask(value)
Getter	get_occluder_light_mask()

The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).

bool sdf_collision

Default	`true`
Setter	set_as_sdf_collision(value)
Getter	is_set_as_sdf_collision()