class_omnilight.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the OmniLight.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_OmniLight:
  5. OmniLight
  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. OmniDirectional Light, such as a light bulb or a candle.
  12. Member Variables
  13. ----------------
  14. .. _class_OmniLight_omni_attenuation:
  15. - :ref:`float<class_float>` **omni_attenuation**
  16. .. _class_OmniLight_omni_range:
  17. - :ref:`float<class_float>` **omni_range**
  18. .. _class_OmniLight_omni_shadow_detail:
  19. - :ref:`int<class_int>` **omni_shadow_detail**
  20. .. _class_OmniLight_omni_shadow_mode:
  21. - :ref:`int<class_int>` **omni_shadow_mode**
  22. Numeric Constants
  23. -----------------
  24. - **SHADOW_DUAL_PARABOLOID** = **0**
  25. - **SHADOW_CUBE** = **1**
  26. - **SHADOW_DETAIL_VERTICAL** = **0**
  27. - **SHADOW_DETAIL_HORIZONTAL** = **1**
  28. Description
  29. -----------
  30. An OmniDirectional light is a type of :ref:`Light<class_light>` node that emits lights in all directions. 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>`.