2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 14:18:53 +01:00
<class name= "OmniLight3D" inherits= "Light3D" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 22:42:36 +02:00
<brief_description >
2018-08-19 06:29:12 +02:00
Omnidirectional light, such as a light bulb or a candle.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2020-03-30 18:22:57 +02:00
An Omnidirectional light is a type of [Light3D] 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.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2021-11-15 10:43:07 +01:00
<link title= "3D lights and shadows" > $DOCS_URL/tutorials/3d/lights_and_shadows.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<members >
2019-06-29 12:38:01 +02:00
<member name= "omni_attenuation" type= "float" setter= "set_param" getter= "get_param" default= "1.0" >
2019-06-22 01:04:47 +02:00
The light's attenuation (drop-off) curve. A number of presets are available in the [b]Inspector[/b] by right-clicking the curve.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "omni_range" type= "float" setter= "set_param" getter= "get_param" default= "5.0" >
2020-06-10 10:07:38 +02:00
The light's radius. Note that the effectively lit area may appear to be smaller depending on the [member omni_attenuation] in use. No matter the [member omni_attenuation] in use, the light will never reach anything outside this radius.
2022-10-08 23:11:49 +02:00
[b]Note:[/b] [member omni_range] is not affected by [member Node3D.scale] (the light's scale or its parent's scale).
2017-09-12 22:42:36 +02:00
</member>
2020-03-30 18:22:57 +02:00
<member name= "omni_shadow_mode" type= "int" setter= "set_shadow_mode" getter= "get_shadow_mode" enum= "OmniLight3D.ShadowMode" default= "1" >
2018-08-19 06:29:12 +02:00
See [enum ShadowMode].
2017-09-12 22:42:36 +02:00
</member>
2022-05-08 10:09:19 +02:00
<member name= "shadow_bias" type= "float" setter= "set_param" getter= "get_param" overrides= "Light3D" default= "0.2" />
2017-09-12 22:42:36 +02:00
</members>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "SHADOW_DUAL_PARABOLOID" value= "0" enum= "ShadowMode" >
2019-06-22 01:04:47 +02:00
Shadows are rendered to a dual-paraboloid texture. Faster than [constant SHADOW_CUBE], but lower-quality.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "SHADOW_CUBE" value= "1" enum= "ShadowMode" >
2019-06-22 01:04:47 +02:00
Shadows are rendered to a cubemap. Slower than [constant SHADOW_DUAL_PARABOLOID], but higher-quality.
2017-09-16 01:46:14 +02:00
</constant>
2017-09-12 22:42:36 +02:00
</constants>
</class>