class_lightoccluder2d.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the LightOccluder2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_LightOccluder2D:
  5. LightOccluder2D
  6. ===============
  7. **Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Occludes light cast by a Light2D, casting shadows.
  12. Member Variables
  13. ----------------
  14. .. _class_LightOccluder2D_light_mask:
  15. - :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).
  16. .. _class_LightOccluder2D_occluder:
  17. - :ref:`OccluderPolygon2D<class_occluderpolygon2d>` **occluder** - The :ref:`OccluderPolygon2D<class_occluderpolygon2d>` used to compute the shadow.
  18. Description
  19. -----------
  20. 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.