diff options
| author | nabfrew <nabfrew@hotmail.com> | 2021-10-18 22:16:32 +0200 |
|---|---|---|
| committer | nabfrew <nabfrew@hotmail.com> | 2021-10-19 09:23:12 +0200 |
| commit | e2e77bbb04c71d6bd00d49ddf9ee3d954339a7c4 (patch) | |
| tree | 69216fe44e0b36ec51dda6d6c5abd39fa6db884e /doc | |
| parent | 5bb3dbbedd4f32974eef36ffc83bbe29abb65ab1 (diff) | |
Clarify 2D lighting `height` property in class reference
It's easy to assume they are the same, but they are quite different for the two types of 2D lights. For myself, it took a bit of confusion and experimentation for me to figure out why this behaviour changed when I changed from point to directional. Hopefully it can save somebody else the trouble.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/DirectionalLight2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/PointLight2D.xml | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/DirectionalLight2D.xml b/doc/classes/DirectionalLight2D.xml index 317cf6e66c..1e5c9bc09a 100644 --- a/doc/classes/DirectionalLight2D.xml +++ b/doc/classes/DirectionalLight2D.xml @@ -8,7 +8,7 @@ </tutorials> <members> <member name="height" type="float" setter="set_height" getter="get_height" default="0.0"> - The height of the light. Used with 2D normal mapping. + The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to the plane) to 1 (perpendicular to the plane). </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="10000.0"> </member> diff --git a/doc/classes/PointLight2D.xml b/doc/classes/PointLight2D.xml index 9c13179056..ec809ed0a8 100644 --- a/doc/classes/PointLight2D.xml +++ b/doc/classes/PointLight2D.xml @@ -8,7 +8,7 @@ </tutorials> <members> <member name="height" type="float" setter="set_height" getter="get_height" default="0.0"> - The height of the light. Used with 2D normal mapping. + The height of the light. Used with 2D normal mapping. The units are in pixels, e.g. if the height is 100, then it will illuminate an object 100 pixels away at a 45° angle to the plane. </member> <member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2(0, 0)"> The offset of the light's [member texture]. |