diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2021-10-26 07:58:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-26 07:58:12 +0200 |
| commit | d9d52963657441e2a033b3b766e1f7e10902c6e5 (patch) | |
| tree | 9571807971c051b6135d190899f1f1421df3ad17 | |
| parent | 64faa37e4501afed96f40b50d42d8a0614cf583d (diff) | |
| parent | e2e77bbb04c71d6bd00d49ddf9ee3d954339a7c4 (diff) | |
Merge pull request #53973 from nabfrew/nabf/light_hight_documentation
Clarify lighting height documentation
| -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]. |