diff options
| author | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/LightOccluder2D.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/LightOccluder2D.xml')
| -rw-r--r-- | doc/classes/LightOccluder2D.xml | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/classes/LightOccluder2D.xml b/doc/classes/LightOccluder2D.xml new file mode 100644 index 0000000000..b60623c8b0 --- /dev/null +++ b/doc/classes/LightOccluder2D.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="LightOccluder2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Occludes light cast by a Light2D, casting shadows. + </brief_description> + <description> + 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> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_occluder_light_mask" qualifiers="const"> + <return type="int"> + </return> + <description> + Return the light mask of the LightOccluder2D. + </description> + </method> + <method name="get_occluder_polygon" qualifiers="const"> + <return type="OccluderPolygon2D"> + </return> + <description> + Return the OccluderPolygon2D that defines the LightOccluder2D. + </description> + </method> + <method name="set_occluder_light_mask"> + <return type="void"> + </return> + <argument index="0" name="mask" type="int"> + </argument> + <description> + Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). + </description> + </method> + <method name="set_occluder_polygon"> + <return type="void"> + </return> + <argument index="0" name="polygon" type="OccluderPolygon2D"> + </argument> + <description> + Set the OccluderPolygon2D that defines the LightOccluder2D. + </description> + </method> + </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> + </constants> +</class> |