SpotLight3D

Inherits: Light3D < VisualInstance3D < Node3D < Node < Object

A spotlight, such as a reflector spotlight or a lantern.

Description

A Spotlight is a type of Light3D node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance. This attenuation can be configured by changing the energy, radius and attenuation parameters of Light3D.

Tutorials

Properties

float

shadow_bias

0.03 (overrides Light3D)

float

shadow_normal_bias

1.0 (overrides Light3D)

float

spot_angle

45.0

float

spot_angle_attenuation

1.0

float

spot_attenuation

1.0

float

spot_range

5.0


Property Descriptions

float spot_angle = 45.0

  • void set_param ( float value )

  • float get_param ( )

The spotlight's angle in degrees.

Note: spot_angle is not affected by Node3D.scale (the light's scale or its parent's scale).


float spot_angle_attenuation = 1.0

  • void set_param ( float value )

  • float get_param ( )

The spotlight's angular attenuation curve.


float spot_attenuation = 1.0

  • void set_param ( float value )

  • float get_param ( )

The spotlight's light energy attenuation curve.


float spot_range = 5.0

  • void set_param ( float value )

  • float get_param ( )

The maximal range that can be reached by the spotlight. Note that the effectively lit area may appear to be smaller depending on the spot_attenuation in use. No matter the spot_attenuation in use, the light will never reach anything outside this range.

Note: spot_range is not affected by Node3D.scale (the light's scale or its parent's scale).