OmniLight3D

Inherits: Light3D < VisualInstance3D < Node3D < Node < Object

Omnidirectional light, such as a light bulb or a candle.

Description

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.

Enumerations

enum ShadowMode:

  • SHADOW_DUAL_PARABOLOID = 0 --- Shadows are rendered to a dual-paraboloid texture. Faster than SHADOW_CUBE, but lower-quality.

  • SHADOW_CUBE = 1 --- Shadows are rendered to a cubemap. Slower than SHADOW_DUAL_PARABOLOID, but higher-quality.

Property Descriptions

Default

1.0

Setter

set_param(value)

Getter

get_param()

The light's attenuation (drop-off) curve. A number of presets are available in the Inspector by right-clicking the curve.


Default

5.0

Setter

set_param(value)

Getter

get_param()

The light's radius. Note that the effectively lit area may appear to be smaller depending on the omni_attenuation in use. No matter the omni_attenuation in use, the light will never reach anything outside this radius.


Default

1

Setter

set_shadow_mode(value)

Getter

get_shadow_mode()

See ShadowMode.