:github_url: hide

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

.. _class_LightOccluder2D:

LightOccluder2D
===============

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

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

Occludes light cast by a Light2D, casting shadows.

Properties
----------

+---------------------------------------------------+--------------------------------------------------------------+
| :ref:`int<class_int>`                             | :ref:`light_mask<class_LightOccluder2D_property_light_mask>` |
+---------------------------------------------------+--------------------------------------------------------------+
| :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` | :ref:`occluder<class_LightOccluder2D_property_occluder>`     |
+---------------------------------------------------+--------------------------------------------------------------+

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

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

Tutorials
---------

- :doc:`../tutorials/2d/2d_lights_and_shadows`

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

.. _class_LightOccluder2D_property_light_mask:

- :ref:`int<class_int>` **light_mask**

+----------+--------------------------------+
| *Setter* | set_occluder_light_mask(value) |
+----------+--------------------------------+
| *Getter* | get_occluder_light_mask()      |
+----------+--------------------------------+

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

----

.. _class_LightOccluder2D_property_occluder:

- :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **occluder**

+----------+-----------------------------+
| *Setter* | set_occluder_polygon(value) |
+----------+-----------------------------+
| *Getter* | get_occluder_polygon()      |
+----------+-----------------------------+

The :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` used to compute the shadow.