mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
112 lines
3.6 KiB
ReStructuredText
112 lines
3.6 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.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+--------------------------------------------------+---------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`omni_attenuation<class_OmniLight_omni_attenuation>` |
|
|
+--------------------------------------------------+---------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`omni_range<class_OmniLight_omni_range>` |
|
|
+--------------------------------------------------+---------------------------------------------------------------+
|
|
| :ref:`ShadowDetail<enum_OmniLight_ShadowDetail>` | :ref:`omni_shadow_detail<class_OmniLight_omni_shadow_detail>` |
|
|
+--------------------------------------------------+---------------------------------------------------------------+
|
|
| :ref:`ShadowMode<enum_OmniLight_ShadowMode>` | :ref:`omni_shadow_mode<class_OmniLight_omni_shadow_mode>` |
|
|
+--------------------------------------------------+---------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_OmniLight_ShadowMode:
|
|
|
|
enum **ShadowMode**:
|
|
|
|
- **SHADOW_DUAL_PARABOLOID** = **0**
|
|
|
|
- **SHADOW_CUBE** = **1**
|
|
|
|
.. _enum_OmniLight_ShadowDetail:
|
|
|
|
enum **ShadowDetail**:
|
|
|
|
- **SHADOW_DETAIL_VERTICAL** = **0**
|
|
|
|
- **SHADOW_DETAIL_HORIZONTAL** = **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`
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_OmniLight_omni_attenuation:
|
|
|
|
- :ref:`float<class_float>` **omni_attenuation**
|
|
|
|
+----------+------------------+
|
|
| *Setter* | set_param(value) |
|
|
+----------+------------------+
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
|
|
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**
|
|
|
|
+----------+------------------+
|
|
| *Setter* | set_param(value) |
|
|
+----------+------------------+
|
|
| *Getter* | get_param() |
|
|
+----------+------------------+
|
|
|
|
Maximum distance the light affects.
|
|
|
|
.. _class_OmniLight_omni_shadow_detail:
|
|
|
|
- :ref:`ShadowDetail<enum_OmniLight_ShadowDetail>` **omni_shadow_detail**
|
|
|
|
+----------+--------------------------+
|
|
| *Setter* | set_shadow_detail(value) |
|
|
+----------+--------------------------+
|
|
| *Getter* | get_shadow_detail() |
|
|
+----------+--------------------------+
|
|
|
|
See :ref:`ShadowDetail<enum_@GlobalScope_ShadowDetail>`.
|
|
|
|
.. _class_OmniLight_omni_shadow_mode:
|
|
|
|
- :ref:`ShadowMode<enum_OmniLight_ShadowMode>` **omni_shadow_mode**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_shadow_mode(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_shadow_mode() |
|
|
+----------+------------------------+
|
|
|
|
See :ref:`ShadowMode<enum_@GlobalScope_ShadowMode>`.
|
|
|