light

From Valve Developer Community
Jump to: navigation, search
简体中文
Light.png
light is a point entity available in all Source games. It creates an invisible, static light source that shines in all directions. Warning: Naming a static light radically changes its behavior. See Naming Lights for details.

Keyvalues

Entity To Point At <targetname>
Entity to point this light at. Non-functional, as this entity casts light in all directions, all the time.
Maximum Distance <integer>
This is the distance that light is allowed to cast, in inches. Non-functional in Source 2013 later, use 50 and 0 percent falloff instead.

Light:

Brightness <color255 + int>
The RGB color and brightness of the light. Colors must be between 0 and 255; brightness can be anything.
BrightnessHDR <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 <float>
A simple intensity multiplier used when compiling HDR lighting.
Appearance <choices>
Various Custom Appearance (see below) presets.
Custom Appearance <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 <float>
Linear <float>
Quadratic <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 <string>
0 percent falloff 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 <bool>
Causes lights to fall to exactly zero beyond the 0% distance. May cause unrealistic lighting if not used carefully.

Appearances

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

Shadowcast:

Cast Shadow (New with Left 4 Dead)
Allows the entity to modify the direction of nearby render-to-texture shadows so that they always point away from its origin. See also shadow_control.

Targetname:

Name <string>
The targetname that other entities refer to this entity by. Warning: Naming a static light radically changes its behavior. See Naming Lights for details.
Entity Scripts <scriptlist> (New with Left 4 Dead 2)
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 <string> (New with Left 4 Dead 2)
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.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Flags

  • Initially Dark - only works when light has a targetname.

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.

Targetname:

Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although entities with a large number of children are killed marginally faster.
AddOutput  <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
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.
RunScriptFile  <script> (New with Left 4 Dead 2)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode  <string> (New with Left 4 Dead 2)
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 <Left 4 Dead 2>, 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> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
Note:This input is missing from some games FGD files.
SetLocalOrigin  <origin> (New with Alien Swarm) !FGD
Set this entity's origin in the map.
Note:This input is missing from some games FGD files.
SetLocalAngles  <angles> (New with Alien Swarm) !FGD
Set this entity's angles in the map.
Note:This input is missing from some games FGD files.

Outputs

Targetname:

OnUser1 to OnUser4
These Outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (New with Left 4 Dead)
This Output fires when the entity is killed and removed from the game.

See also