summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorclayjohn <claynjohn@gmail.com>2020-10-21 23:22:53 -0700
committerclayjohn <claynjohn@gmail.com>2020-10-21 23:28:08 -0700
commit6299575250cf332689ac85a4f86e36d70ca5832c (patch)
tree6b27db2761f4314c27f3c29b91ba748073bc46bb /doc
parentc3964b6c835a98db9784aada41574447b6cd5824 (diff)
Add sky_only setting to DirectionalLight3Ds
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/DirectionalLight3D.xml3
-rw-r--r--doc/classes/RenderingServer.xml11
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/classes/DirectionalLight3D.xml b/doc/classes/DirectionalLight3D.xml
index afd85a9cb7..233b1f0c16 100644
--- a/doc/classes/DirectionalLight3D.xml
+++ b/doc/classes/DirectionalLight3D.xml
@@ -41,6 +41,9 @@
</member>
<member name="shadow_bias" type="float" setter="set_param" getter="get_param" override="true" default="0.05" />
<member name="shadow_normal_bias" type="float" setter="set_param" getter="get_param" override="true" default="1.0" />
+ <member name="use_in_sky_only" type="bool" setter="set_sky_only" getter="is_sky_only" default="false">
+ If [code]true[/code], this [DirectionalLight3D] will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon.
+ </member>
</members>
<constants>
<constant name="SHADOW_ORTHOGONAL" value="0" enum="ShadowMode">
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
index 857c13deb5..4c5ec13cd0 100644
--- a/doc/classes/RenderingServer.xml
+++ b/doc/classes/RenderingServer.xml
@@ -1432,6 +1432,17 @@
Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options.
</description>
</method>
+ <method name="light_directional_set_sky_only">
+ <return type="void">
+ </return>
+ <argument index="0" name="light" type="RID">
+ </argument>
+ <argument index="1" name="enable" type="bool">
+ </argument>
+ <description>
+ If [code]true[/code], this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon.
+ </description>
+ </method>
<method name="light_omni_set_shadow_mode">
<return type="void">
</return>