| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- :github_url: hide
- .. 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.
- Properties
- ----------
- +---------------------------+--------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`spot_angle<class_SpotLight_property_spot_angle>` |
- +---------------------------+--------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`spot_angle_attenuation<class_SpotLight_property_spot_angle_attenuation>` |
- +---------------------------+--------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`spot_attenuation<class_SpotLight_property_spot_attenuation>` |
- +---------------------------+--------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`spot_range<class_SpotLight_property_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>`.
- Tutorials
- ---------
- - :doc:`../tutorials/3d/lights_and_shadows`
- Property Descriptions
- ---------------------
- .. _class_SpotLight_property_spot_angle:
- - :ref:`float<class_float>` **spot_angle**
- +----------+------------------+
- | *Setter* | set_param(value) |
- +----------+------------------+
- | *Getter* | get_param() |
- +----------+------------------+
- ----
- .. _class_SpotLight_property_spot_angle_attenuation:
- - :ref:`float<class_float>` **spot_angle_attenuation**
- +----------+------------------+
- | *Setter* | set_param(value) |
- +----------+------------------+
- | *Getter* | get_param() |
- +----------+------------------+
- ----
- .. _class_SpotLight_property_spot_attenuation:
- - :ref:`float<class_float>` **spot_attenuation**
- +----------+------------------+
- | *Setter* | set_param(value) |
- +----------+------------------+
- | *Getter* | get_param() |
- +----------+------------------+
- ----
- .. _class_SpotLight_property_spot_range:
- - :ref:`float<class_float>` **spot_range**
- +----------+------------------+
- | *Setter* | set_param(value) |
- +----------+------------------+
- | *Getter* | get_param() |
- +----------+------------------+
|
