light
![]() |
This Entity is also available as Light (GoldSource Engine) for the GoldSource Engine. |

light
is a point entity available in all Source games. It creates an invisible, static light source that shines in all directions.

Contents
Keyvalues
Entity To Point At(target)
<targetname>
- Deprecated. Entity to point this light at. Non-functional, as this entity casts light in all directions, all the time.
- Maximum Distance
(_distance)
<integer>
- This is the distance that light is allowed to cast, in inches. Non-functional in
Source 2013 and later, use 50 and 0 percent falloff instead.
Light:
- Brightness
(_light)
<color255 + int>
- The RGB color and brightness of the light. Colors must be between 0 and 255; brightness can be anything.
- BrightnessHDR
(_lightHDR)
<color255 + int>
- Brightness override used in HDR mode. Default is
-1 -1 -1 1
, which means no change. Warning: The fourth digit must be positive. Otherwise all light will be sucked out of your map!
- BrightnessScaleHDR
(_lightHDRscale)
<float>
- A simple intensity multiplier used when compiling HDR lighting.
- Appearance
(style)
<choices>
- Various Custom Appearance presets.
Light Appearances 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 !FGD Underwater light mutation mmnnmmnnnmmnn
- Custom Appearance
(pattern)
<string>
- A string of characters, like a sequence of piano keys, that define a pattern of brightness. a is dark and z is full intensity. Applies only to lights with a targetname.
- Constant
(_constant_attn)
<float>
- Linear
(_linear_attn)
<float>
- Quadratic
(_quadratic_attn)
<float>
- These three values determine how the intensity of the emitted light falls off over distance. See Constant-Linear-Quadratic Falloff.
- 50 percent falloff distance
(_fifty_percent_distance))
<string>
- 0 percent falloff distance
(_zero_percent_distance)
<string>
- Distances at which brightness should have fallen to 50% and (1/256)% respectively. Overrides Linear/Constant/Quadratic parameters if non-zero.
Bug: Using this setting will sometimes not work, which may or may not be related to using the light inside of an instance. Collapsing the instance and messing with the light's falloff values seems to help.
- Hard falloff
(_hardfalloff)
<boolean>
- Causes lights to fall to exactly zero beyond the 0% distance. May cause unrealistic lighting if not used carefully.
- Cast entity shadows
(_castentityshadow)
<boolean>
(in all games since) (also in
)
- Allows the light to modify the direction of nearby render-to-texture shadows so that they always point away from its origin. See also
shadow_control
. Note: This keyvalue may not be available in some FGDs.
- Shadow cast offset
(_shadoworiginoffset)
<vector>
(in all games since)
- A world-space offset that gets applied to the light origin when casting entity shadows. Useful for dealing with funny-looking shadows from very low lights: Just offset up the z axis. Default
0 0 0
. Note: This keyvalue may not be available in some FGDs.
Base:
- Classname
(classname)
<string>
- The classname defines the type of entity. Classnames can be changed using
AddOutput
, which will influence how the engine deals with the entity in certain circumstances. - Name
(targetname)
<string>
- The name that other entities refer to this entity by.
- Global Entity Name
(globalname)
<string>
- Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
- Parent
(parentname)
<targetname>
- Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma. Every entity can be parented, even point entities. Entities which are parented will be forced to transition to the next map, such as from a
trigger_transition
. Some entities which aren't intended to be parented may not function correctly.phys_constraint
can be used as a workaround to parenting. - Origin (X Y Z)
(origin)
<coordinates>
- The position of this entity's center in the world. Rotating entities typically rotate around their origin.
- Pitch Yaw Roll (X Y Z)
(angles)
<angle>
- 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.
Note: This works on brush entities, although Hammer doesn't show the new angles.
- Flags
(spawnflags)
<integer>
- Toggles features of an entity, its specific number is determined by the combination of flags added.
- Response Contexts
(ResponseContext)
<string>
- Pre-defined response system contexts for this entity. Format is
key:value,key:value,...
. Contexts may be filtered. - Effects
(effects)
<integer>
!FGD - Combination of effect flags to use.
- Local Time
(ltime)
<float>
!FGD - The local time of the entity, independent of the global clock. Used mainly for physics calculations.
- Next Think
(nextthink)
<float>
!FGD - Amount of time before the entity thinks again.
- Hammer ID
(hammerid)
<integer>
!FGD - The entity's Hammer ID. Mainly used by plugins and debugging commands, such as
ent_keyvalue
. Can be manually assigned with the "hammerid" or "id" keyvalue. Entities spawned at run-time are not assigned any Hammer ID. - Disable for Xbox 360
(disableX360)
<boolean>
(in all games since) !FGD
- If Yes, disables this entity on the Xbox 360 version of Source.
- Entity Scripts
(vscripts)
<scriptlist>
(in all games since)
- Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
- Script think function
(thinkfunction)
<string>
(in all games since)
- Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call. Try to avoid expensive operations in this function, as it may cause performance problems.
- Lag Compensation
(LagCompensate)
<boolean>
(in all games since) !FGD
- Set to Yes to lag compensate this entity. Should be used very sparingly!
- Is Automatic-Aim Target
(is_autoaim_target)
<boolean>
(in all games since) !FGD
- If set to 1, this entity will slow down aiming movement for consoles and joystick controllers when the entity is under the crosshairs.
Flags
- [
1
] : Initially dark
- Spawns with the light turned off, so a light switch or similar can turn it on.
Inputs
TurnOn
- Turn the light on.
TurnOff
- The the light off.
Toggle
- Toggle the light's current state.
SetPattern
<string>
- Set a custom pattern of light brightness for this light. If the Light is off, then this input appears to turn it on.
FadeToPattern
<string>
- Fades from first value in old pattern, to first value in the new given pattern. If the Light is off, then this input appears to turn it on.
Base:
Kill
- Removes this entity and any entities parented to it from the world.
KillHierarchy
- Functions the same as
Kill
, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKill
. SetParent
<string>
- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<string>
- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset
<string>
- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
AddOutput
<string>
- Evaluates a keyvalue/output on this entity.
Format:<key> <value>
Format:<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1
toFireUser4
- Fire the
OnUser
outputs; see User Inputs and Outputs. Use
!FGD- Same as a player invoking +use; may not do anything. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs. DispatchEffect
<string>
(removed in) !FGD
- Dispatches a special effect from the entity's origin. Removed and replaced entirely by the particle system since
.
DispatchResponse
<string>
!FGD- Dispatches a response to the entity. See Response and Concept.
AddContext
<string>
- Adds to the entity's list of response contexts. Format is
<key>:<value>
. RemoveContext
<string>
- Remove a context from this entity's list. The name should match the key of an existing context.
ClearContext
<string>
- Removes all contexts from this entity's list.
RunScriptFile
<script>
(in all games since)
- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode
<string>
(in all games since)
- Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug: In
, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction
<string>
(in all games since) !FGD
- Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin
<coordinates>
(in all games since) !FGD
- Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles
<angles>
(in all games since) !FGD
- Set this entity's angles.
Outputs
Base:
OnUser1
toOnUser4
- These outputs each fire in response to the firing of the like-numbered
FireUser1
toFireUser4
Input; see User Inputs and Outputs. OnKilled
(only in)
- This output fires when the entity is killed and removed from the game.
See also
light_spot
- Lighting
- Adding Light
- Intermediate Lighting
- Advanced Lighting
- Effect_flags (dynamic light effects)
- Tool textures (for Block light)
$reflectivity
(controlling reflected light off surfaces)