summaryrefslogtreecommitdiff
path: root/doc/classes/SpotLight3D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/SpotLight3D.xml')
-rw-r--r--doc/classes/SpotLight3D.xml30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/classes/SpotLight3D.xml b/doc/classes/SpotLight3D.xml
new file mode 100644
index 0000000000..f094818c21
--- /dev/null
+++ b/doc/classes/SpotLight3D.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="SpotLight3D" inherits="Light3D" version="4.0">
+ <brief_description>
+ A spotlight, such as a reflector spotlight or a lantern.
+ </brief_description>
+ <description>
+ A Spotlight is a type of [Light3D] 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 [Light3D].
+ </description>
+ <tutorials>
+ <link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link>
+ </tutorials>
+ <methods>
+ </methods>
+ <members>
+ <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" default="1.0">
+ The spotlight's angular attenuation curve.
+ </member>
+ <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" default="5.0">
+ The maximal range that can be reached by the spotlight.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>