GLTFLight

Represents a glTF light.

Description

Represents a light as defined by theKHR_lights_punctual glTF extension.

Tutorials

Properties

Color	color	`Color(1,1,1,1)`
float	inner_cone_angle	`0.0`
float	intensity	`1.0`
String	light_type	`""`
float	outer_cone_angle	`0.785398`
float	range	`inf`

Methods

GLTFLight	from_dictionary(dictionary:Dictionary)static
GLTFLight	from_node(light_node:Light3D)static
Variant	get_additional_data(extension_name:StringName)
void	set_additional_data(extension_name:StringName, additional_data:Variant)
Dictionary	to_dictionary()const
Light3D	to_node()const

Property Descriptions

Colorcolor =Color(1,1,1,1)🔗

voidset_color(value:Color)
Colorget_color()

TheColor of the light. Defaults to white. A black color causes the light to have no effect.

floatinner_cone_angle =0.0🔗

voidset_inner_cone_angle(value:float)
floatget_inner_cone_angle()

The inner angle of the cone in a spotlight. Must be less than or equal to the outer cone angle.

Within this angle, the light is at full brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. When creating a GodotSpotLight3D, the ratio between the inner and outer cone angles is used to calculate the attenuation of the light.

floatintensity =1.0🔗

voidset_intensity(value:float)
floatget_intensity()

The intensity of the light. This is expressed in candelas (lumens per steradian) for point and spot lights, and lux (lumens per m²) for directional lights. When creating a Godot light, this value is converted to a unitless multiplier.

Stringlight_type =""🔗

voidset_light_type(value:String)
Stringget_light_type()

The type of the light. The values accepted by Godot are "point", "spot", and "directional", which correspond to Godot'sOmniLight3D,SpotLight3D, andDirectionalLight3D respectively.

floatouter_cone_angle =0.785398🔗

voidset_outer_cone_angle(value:float)
floatget_outer_cone_angle()

The outer angle of the cone in a spotlight. Must be greater than or equal to the inner angle.

At this angle, the light drops off to zero brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. If this angle is a half turn, then the spotlight emits in all directions. When creating a GodotSpotLight3D, the outer cone angle is used as the angle of the spotlight.

floatrange =inf🔗

voidset_range(value:float)
floatget_range()

The range of the light, beyond which the light has no effect. glTF lights with no range defined behave like physical lights (which have infinite range). When creating a Godot light, the range is clamped to 4096.