diff options
| author | Poommetee Ketson <poommetee@protonmail.com> | 2017-09-12 05:39:05 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-12 05:39:05 +0700 |
| commit | 1aa5fe387fca82d5856f5f348906ae37b7092a97 (patch) | |
| tree | 7b53404fce5a99812c7959b5111e154a89d969de | |
| parent | b259fcfbd3b53e78fba09fcc089a4a0c7782a6cd (diff) | |
| parent | 134e24408a3ae6273da5998ee257495eff79eb1a (diff) | |
Merge pull request #11120 from cbscribe/kcc_lightoccluder2d_doc
Update LightOccluder2D class ref
| -rw-r--r-- | doc/base/classes.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 0fbb39def0..5a3f4ac526 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -26285,10 +26285,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"> @@ -26326,8 +26326,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> |