diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-11-14 23:24:48 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-11-14 23:24:48 +0100 |
| commit | 130abf5692a12913c3dcb5cbc9277315b71b35da (patch) | |
| tree | 5049d78d1dd3f6ce42d2e8577b03eb23721699d6 | |
| parent | bd001190f035f2892968f57c5775ffd771427344 (diff) | |
| parent | bda589bffe39a0bba67981deea08f9211e48668b (diff) | |
Merge pull request #68552 from DarkKilauea/update-directional-light-docs
Add documentation for DirectionalLight2D
| -rw-r--r-- | doc/classes/DirectionalLight2D.xml | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/DirectionalLight2D.xml b/doc/classes/DirectionalLight2D.xml index a1b8ea86be..7a54980c19 100644 --- a/doc/classes/DirectionalLight2D.xml +++ b/doc/classes/DirectionalLight2D.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="DirectionalLight2D" inherits="Light2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Directional light from a distance. </brief_description> <description> + A directional light is a type of [Light2D] node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene (for example: to model sunlight or moonlight). </description> <tutorials> </tutorials> @@ -11,6 +13,7 @@ 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"> + Maximum distance this light covers. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (due to more objects being included in shadow rendering). </member> </members> </class> |