summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Bradfield <chris@kidscancode.org>2017-09-09 13:15:01 -0700
committerChris Bradfield <chris@kidscancode.org>2017-09-09 13:15:01 -0700
commitf66e9158a8a49d1fb88cd31975a2a492b3aa1d6e (patch)
treeed2a61a67dfe673cdf54708f3fc62c8d4d58bc8d
parent0b747c29106e0e02f8c9b674cde418a7d270d987 (diff)
Update LightOccluder2D class ref
-rw-r--r--doc/base/classes.xml6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 96d515de5e..c9213d8201 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -26154,10 +26154,10 @@
</class>
<class name="LightOccluder2D" inherits="Node2D" category="Core">
<brief_description>
- Occludes light cast by a Light2D, thus casting shadows.
+ Occludes light cast by a Light2D, casting shadows.
</brief_description>
<description>
- Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows.
+ Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an [OccluderPolygon2D] in order for the shadow to be computed.
</description>
<methods>
<method name="get_occluder_light_mask" qualifiers="const">
@@ -26195,8 +26195,10 @@
</methods>
<members>
<member name="light_mask" type="int" setter="set_occluder_light_mask" getter="get_occluder_light_mask" brief="">
+ The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).
</member>
<member name="occluder" type="OccluderPolygon2D" setter="set_occluder_polygon" getter="get_occluder_polygon" brief="">
+ The [OccluderPolygon2D] used to compute the shadow.
</member>
</members>
<constants>