diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-28 12:36:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-28 12:36:41 +0200 |
| commit | 6e03236574467d6a0c3aca1b0375da59423b0083 (patch) | |
| tree | 7da85ef95f4fc66559218976bb08a87143ae3c8c /doc/classes/SpotLight.xml | |
| parent | 7b10bae916dabcf1639fa1ee99c5fefd2790a1ca (diff) | |
| parent | f7f6115f7627df24a08a9a0882b2f573cc838eb1 (diff) | |
Merge pull request #30134 from Calinou/doc-proofread
Proofread and improve the whole class reference
Diffstat (limited to 'doc/classes/SpotLight.xml')
| -rw-r--r-- | doc/classes/SpotLight.xml | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/classes/SpotLight.xml b/doc/classes/SpotLight.xml index 7369189c72..edd578a5b0 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> @@ -13,12 +13,16 @@ </methods> <members> <member name="spot_angle" type="float" setter="set_param" getter="get_param"> + The spotlight's angle in degrees. </member> <member name="spot_angle_attenuation" type="float" setter="set_param" getter="get_param"> + The spotlight's angular attenuation curve. </member> <member name="spot_attenuation" type="float" setter="set_param" getter="get_param"> + The spotlight's light energy attenuation curve. </member> <member name="spot_range" type="float" setter="set_param" getter="get_param"> + The maximal range that can be reached by the spotlight. </member> </members> <constants> |