Files
godot-docs/classes/class_omnilight.rst
2018-01-12 08:52:43 +01:00

62 lines
1.5 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the OmniLight.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_OmniLight:
OmniLight
=========
**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
-----------------
OmniDirectional Light, such as a light bulb or a candle.
Member Variables
----------------
.. _class_OmniLight_omni_attenuation:
- :ref:`float<class_float>` **omni_attenuation**
.. _class_OmniLight_omni_range:
- :ref:`float<class_float>` **omni_range**
.. _class_OmniLight_omni_shadow_detail:
- :ref:`ShadowDetail<enum_omnilight_shadowdetail>` **omni_shadow_detail**
.. _class_OmniLight_omni_shadow_mode:
- :ref:`ShadowMode<enum_omnilight_shadowmode>` **omni_shadow_mode**
Enums
-----
.. _enum_OmniLight_ShadowDetail:
enum **ShadowDetail**
- **SHADOW_DETAIL_VERTICAL** = **0**
- **SHADOW_DETAIL_HORIZONTAL** = **1**
.. _enum_OmniLight_ShadowMode:
enum **ShadowMode**
- **SHADOW_DUAL_PARABOLOID** = **0**
- **SHADOW_CUBE** = **1**
Description
-----------
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>`.