godot-docs/classes/class_light.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Light.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Light:

Light
=====

**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Inherited By:** :ref:`SpotLight<class_spotlight>`, :ref:`OmniLight<class_omnilight>`, :ref:`DirectionalLight<class_directionallight>`

**Category:** Core

Brief Description
-----------------

Provides a base class for different kinds of light nodes.

Member Variables
----------------

  .. _class_Light_editor_only:

- :ref:`bool<class_bool>` **editor_only**

  .. _class_Light_light_bake_mode:

- :ref:`BakeMode<enum_light_bakemode>` **light_bake_mode**

  .. _class_Light_light_color:

- :ref:`Color<class_color>` **light_color**

  .. _class_Light_light_cull_mask:

- :ref:`int<class_int>` **light_cull_mask**

  .. _class_Light_light_energy:

- :ref:`float<class_float>` **light_energy**

  .. _class_Light_light_indirect_energy:

- :ref:`float<class_float>` **light_indirect_energy**

  .. _class_Light_light_negative:

- :ref:`bool<class_bool>` **light_negative**

  .. _class_Light_light_specular:

- :ref:`float<class_float>` **light_specular**

  .. _class_Light_shadow_bias:

- :ref:`float<class_float>` **shadow_bias**

  .. _class_Light_shadow_color:

- :ref:`Color<class_color>` **shadow_color**

  .. _class_Light_shadow_contact:

- :ref:`float<class_float>` **shadow_contact**

  .. _class_Light_shadow_enabled:

- :ref:`bool<class_bool>` **shadow_enabled**

  .. _class_Light_shadow_reverse_cull_face:

- :ref:`bool<class_bool>` **shadow_reverse_cull_face**


Enums
-----

  .. _enum_Light_BakeMode:

enum **BakeMode**

- **BAKE_DISABLED** = **0**
- **BAKE_INDIRECT** = **1**
- **BAKE_ALL** = **2**

  .. _enum_Light_Param:

enum **Param**

- **PARAM_ENERGY** = **0**
- **PARAM_INDIRECT_ENERGY** = **1**
- **PARAM_SPECULAR** = **2**
- **PARAM_RANGE** = **3**
- **PARAM_ATTENUATION** = **4**
- **PARAM_SPOT_ANGLE** = **5**
- **PARAM_SPOT_ATTENUATION** = **6**
- **PARAM_CONTACT_SHADOW_SIZE** = **7**
- **PARAM_SHADOW_MAX_DISTANCE** = **8**
- **PARAM_SHADOW_SPLIT_1_OFFSET** = **9**
- **PARAM_SHADOW_SPLIT_2_OFFSET** = **10**
- **PARAM_SHADOW_SPLIT_3_OFFSET** = **11**
- **PARAM_SHADOW_NORMAL_BIAS** = **12**
- **PARAM_SHADOW_BIAS** = **13**
- **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14**
- **PARAM_MAX** = **15**


Description
-----------

Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting.