zCVobLight

Represents a virtual light source which lights up nearby game objects. Point and spot light sources are supported and may be animated with different colors and ranges.

Class members

Class member overview

lightPresetInUse

The name of the selected light template. Templates can be found in _work/data/Presets/LightPresets.zen. This property is irrelevant for most use-cases.

lightType

The type of the light source.

Accepted values:

• POINT — A point light source.
• SPOT — A spot light source.

range

The range in which this light source illuminates objects.

color

The color of this light source in RGBA form.

spotConeAngle

The angle of the beam cone for spotlights. Only relevant if lightType is SPOT, ignored otherwise.

lightStatic

Determines whether this is a static light or not. Static lights are baked into the world when its lighting is compiled. This makes static lights faster at runtime, but it also means, that they cannot change in any way after the world is compiled.

Accepted values:

• TRUE — This light is a static light.
• FALSE — This light is a dynamic light.

lightQuality

Determines the quality of the light source. What exactly changes with these values is unknown.

Accepted values:

• HIGH — Highest quality.
• MEDIUM — Medium quality.
• LOW_FASTEST — Low quality (used for almost all lights).

lensflareFX

The name of the lensflare effect associated with this light. Empty if there is no associated lensflare effect.

turnedOn

Whether this dynamic light is turned on.

Accepted values:

• TRUE — The light is turned on.
• FALSE — The light is turned off.

rangeAniScale

Frames for the light's range animation. Its value is a space-separated list of floats where each float is one key frame of the animation. A value of 1.0 corresponds to the initial range of the light source, a value of 2.0 corresponds to double the initial range and a value of 0.5 means half the initial range. The range animation is further controlled by rangeAniFPS and rangeAniSmooth.

rangeAniFPS

The speed of the range animation in frames per second. The animation frames are defined in rangeAniScale

rangeAniSmooth

Whether the range animation should smoothly interpolate between keyframes.

Accepted values:

• TRUE — Turn on interpolation.
• FALSE — Turn off interpolation.

colorAniList

Frames for the light's color animation. Its value is a space-separated list of colors where each element can either be an RGB color consisting of three integers enclosed by parentheses or a greyscale color consisting of a single integer. For example: (255 0 0) 100 (255 50 180) would result in #ff0000 #646464, #ff32b4. The color animation is further controlled by colorAniFPS and colorAniSmooth.

colorAniFPS

The speed of the color animation in frames per second. The animation frames are defined in colorAniList

colorAniSmooth

Whether the color animation should smoothly interpolate between keyframes.

Accepted values:

• TRUE — Turn on interpolation.
• FALSE — Turn off interpolation.

canMove

Unknown.