mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 20:29:03 +00:00
67 lines
1.8 KiB
ReStructuredText
67 lines
1.8 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** - The light's attenuation (drop-off) curve. A number of presets are available in the Inspector.
|
|
|
|
.. _class_OmniLight_omni_range:
|
|
|
|
- :ref:`float<class_float>` **omni_range** - Maximum distance the light affects.
|
|
|
|
.. _class_OmniLight_omni_shadow_detail:
|
|
|
|
- :ref:`ShadowDetail<enum_omnilight_shadowdetail>` **omni_shadow_detail** - See :ref:`ShadowDetail<enum_@globalscope_shadowdetail>`.
|
|
|
|
.. _class_OmniLight_omni_shadow_mode:
|
|
|
|
- :ref:`ShadowMode<enum_omnilight_shadowmode>` **omni_shadow_mode** - See :ref:`ShadowMode<enum_@globalscope_shadowmode>`.
|
|
|
|
|
|
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>` that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/3d/lights_and_shadows`
|
|
|