:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/LightOccluder2D.xml.

.. _class_LightOccluder2D:

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

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_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 :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` in order for the shadow to be computed.

Tutorials
---------

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

Properties
----------

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

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

.. _class_LightOccluder2D_property_light_mask:

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

+-----------+--------------------------------+
| *Default* | ``1``                          |
+-----------+--------------------------------+
| *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.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`