LightOccluder2D.xml 1.1 KB

12345678910111213141516171819202122232425
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="LightOccluder2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Occludes light cast by a Light2D, casting shadows.
  5. </brief_description>
  6. <description>
  7. Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an [OccluderPolygon2D] in order for the shadow to be computed.
  8. </description>
  9. <tutorials>
  10. <link>$DOCS_URL/tutorials/2d/2d_lights_and_shadows.html</link>
  11. </tutorials>
  12. <methods>
  13. </methods>
  14. <members>
  15. <member name="light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask" default="1">
  16. The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).
  17. </member>
  18. <member name="occluder" type="OccluderPolygon2D" setter="set_occluder_polygon" getter="get_occluder_polygon">
  19. The [OccluderPolygon2D] used to compute the shadow.
  20. </member>
  21. </members>
  22. <constants>
  23. </constants>
  24. </class>