Merge pull request #53973 from nabfrew/nabf/light_hight_documentation

Clarify lighting height documentation
godotengine · Oct 26, 2021 · d9d5296 · d9d5296
2 parents 64faa37 + e2e77bb
commit d9d5296
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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].