light_environment

Class hierarchy
CEnvLight ↳CLight ↳CPointEntity ↳CBaseEntity
lights.cpp

GoldSrc

Source Engine

Source 2

light_environment is a point entity available in all GoldSrc games.

Description

Creates the sunlight emitted from sky brushes. There needs to be one per PVS if using the default compile tools. Only one is needed per map if using the ZHLT compile tools.

Key values

Todo: Document _diffuse_light and _spread, added with ZHLT, and _diffuse_light2, added with VHLT.

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Important:Naming a static light radically changes its behavior. See Naming Lights for details.

Pitch Yaw Roll (Y Z X) (angles) <QAngle>

This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Pitch (pitch) <angle>

Overrides the pitch value in Angles, even if omitted, so it needs to be specified. Contrary to Angles, the rotation of this pitch is measured counter-clockwise from the horizontal, so that 90 is straight up, while -90 is straight down. (It's simply the negative of a normal pitch value.)

Light:

Color + Brightness (_light) <color255 + int>

The RGB color and brightness of the light. Colors must be between 0 and 255; brightness can be anything.

Note:Negative brightness will suck out the amount of lighting that the equivalent positive brightness would cast.

Appearance (lightstyle) (style) <choices>

Various lightstyle presets. Cannot be used on named lights.

Lightstyle presets (epilepsy warning)

Literal Value	Description	Sequence	Preview
0	Normal	m
10	Fluorescent flicker	mmamammmmammamamaaamammma
2	Slow, strong pulse	abcdefghijklmnopqrstuvwxyzyxwvutsrqponmlkjihgfedcba
11	Slow pulse, noblack	abcdefghijklmnopqrrqponmlkjihgfedcba
5	Gentle pulse	jklmnopqrstuvwxyzyxwvutsrqponmlkj
1	Flicker A	mmnmmommommnonmmonqnmmo
6	Flicker B	nmonqnmomnmomomno
3	Candle A	mmmmmaaaaammmmmaaaaaabcdefgabcdefg
7	Candle B	mmmaaaabcdefgmmmmaaaammmaamm
8	Candle C	mmmaaammmaaammmabcdefaaaammmmabcdefmmmaaaa
4	Fast strobe	mamamamamama
9	Slow strobe	aaaaaaaazzzzzzzz
12	Underwater light mutation	mmnnmmnnnmmnn
63	Testing (Off) !FGD	a

Custom Appearance (pattern) <string>

A string of english letters, like a sequence of piano keys, that define a pattern of brightness. a is 0%, m is 100%, and z is 200%. Updates at 10 Hz. Requires light to have a targetname.

ZHLT light source:

ZHLT Fade <float>

ZHLT Falloff <integer>

• 0 : Default
• 1 : Inverse Linear
• 2 : Inverse Square

Texlight (VHLT+) (_tex) <texture>

HLCSG will rename this entity to light_surface, using the specified texture as the emissive texture. See light_surface page for additional relevant KVs.

Ambient (ZHLT+) (_diffuse_light) <color255 + int>

Ambient 2 (ZHLT+) (_diffuse_light2) <color255 + int>

Sun spread angle (_spread) <integer>

Model lighting only (VHLT v16+) (_fake) <boolean>

Treat this entity as an info_sunlight, causing it to not affect lightmaps.