Files
godot-docs/classes/class_lightoccluder2d.rst
T

35 lines
1.2 KiB
ReStructuredText

.. 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.
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.
Property Descriptions
---------------------
.. _class_LightOccluder2D_light_mask:
- :ref:`int<class_int>` **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_occluder:
- :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **occluder** - The :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` used to compute the shadow.