DynamicSpotlightGeComponentDef

Inheritance 1 ancestor · 40 siblings

IGeComponentDef

Class Documentation

The definition of a DynamicSpotlightGeComponent: a spotlight carried by a game entity, on a DynamicSpotlightEntityTemplate. The light starts at the entity's position and moves with it.

The light goes into the same light lists as a MapDynamicSpotlight. That page describes the projected texture and the texture atlas. MapDynamicLighting describes the surfaces, the masks and the light types. The light is drawn only on a map that has that component.

Properties

Aspect

F32 = 1

Documentation Edit documentation

Width of the frustum divided by its height.

CastsShadows

Bool = false

Documentation Edit documentation

false makes a dynamic light without a shadow, true a dynamic light with a shadow map: light types 1 and 2 on MapDynamicLighting.

Color

Vec4 = [1, 1, 1, 1]

Documentation Edit documentation

Colour of the light. The red, green and blue values are multiplied by intensity.

HdrScale

F32 = 5

Documentation Edit documentation

Extra multiplier on the colour, used only by PBR-style shaders.

Impact

U8 = 3

Documentation Edit documentation

Which kind of surface the light reaches. Bit 0x1 is environment, bit 0x2 is characters.

LightChannels

U8 = 1

Documentation Edit documentation

Bitmask of light channels. The light reaches an object only when the object's own light channels share a bit with it.

Near

F32 = 10

Documentation Edit documentation

Distance from the light to the near plane of its frustum, in world units.

ProjectedTexture

File = "0x0"

Type history (2 revisions)

16.11 - 16.16 String
since 16.17 File

Documentation Edit documentation

The texture that the light projects. The component loads it when the entity spawns. A spotlight whose projected texture does not resolve is not drawn.