summaryrefslogtreecommitdiff
path: root/doc/classes/SpotLight.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/SpotLight.xml')
-rw-r--r--doc/classes/SpotLight.xml16
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml
index 7369189c72..93aee55b99 100644
--- a/doc/classes/SpotLight.xml
+++ b/doc/classes/SpotLight.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpotLight" inherits="Light" category="Core" version="3.2">
<brief_description>
- Spotlight [Light], such as a reflector spotlight or a lantern.
+ A spotlight, such as a reflector spotlight or a lantern.
</brief_description>
<description>
- A SpotLight light is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light].
+ A Spotlight is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance. This attenuation can be configured by changing the energy, radius and attenuation parameters of [Light].
</description>
<tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link>
@@ -12,13 +12,17 @@
<methods>
</methods>
<members>
- <member name="spot_angle" type="float" setter="set_param" getter="get_param">
+ <member name="spot_angle" type="float" setter="set_param" getter="get_param" default="45.0">
+ The spotlight's angle in degrees.
</member>
- <member name="spot_angle_attenuation" type="float" setter="set_param" getter="get_param">
+ <member name="spot_angle_attenuation" type="float" setter="set_param" getter="get_param" default="1.0">
+ The spotlight's angular attenuation curve.
</member>
- <member name="spot_attenuation" type="float" setter="set_param" getter="get_param">
+ <member name="spot_attenuation" type="float" setter="set_param" getter="get_param" default="1.0">
+ The spotlight's light energy attenuation curve.
</member>
- <member name="spot_range" type="float" setter="set_param" getter="get_param">
+ <member name="spot_range" type="float" setter="set_param" getter="get_param" default="5.0">
+ The maximal range that can be reached by the spotlight.
</member>
</members>
<constants>