class_spotlight.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the SpotLight.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_SpotLight:
  5. SpotLight
  6. =========
  7. **Inherits:** :ref:`Light<class_light>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Spotlight :ref:`Light<class_light>`, such as a reflector spotlight or a lantern.
  12. Member Variables
  13. ----------------
  14. .. _class_SpotLight_spot_angle:
  15. - :ref:`float<class_float>` **spot_angle**
  16. .. _class_SpotLight_spot_angle_attenuation:
  17. - :ref:`float<class_float>` **spot_angle_attenuation**
  18. .. _class_SpotLight_spot_attenuation:
  19. - :ref:`float<class_float>` **spot_attenuation**
  20. .. _class_SpotLight_spot_range:
  21. - :ref:`float<class_float>` **spot_range**
  22. Description
  23. -----------
  24. 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.