Files
godot-docs/classes/class_spotlight.rst
2017-10-21 13:55:57 +02:00

44 lines
1.3 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SpotLight.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_SpotLight:
SpotLight
=========
**Inherits:** :ref:`Light<class_light>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Spotlight :ref:`Light<class_light>`, such as a reflector spotlight or a lantern.
Member Variables
----------------
.. _class_SpotLight_spot_angle:
- :ref:`float<class_float>` **spot_angle**
.. _class_SpotLight_spot_angle_attenuation:
- :ref:`float<class_float>` **spot_angle_attenuation**
.. _class_SpotLight_spot_attenuation:
- :ref:`float<class_float>` **spot_attenuation**
.. _class_SpotLight_spot_range:
- :ref:`float<class_float>` **spot_range**
Description
-----------
A SpotLight light is a type of :ref:`Light<class_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 :ref:`Light<class_light>`. TODO: Image of a spotlight.