This article's documentation is for anything that uses the Source engine. Click here for more information.

light_dynamic

From Valve Developer Community
Jump to: navigation, search
Light.png

light_dynamic is a point entity available in all Source Source games.

English (en)
Edit
class hierarchy
CDynamicLight defined in dynamiclight.cpp
CBaseEntity

It is an invisible light source that changes over time. Can be turned on and off through inputs, and can aim at any object, including moving ones. Dynamic lights are calculated on the fly in the game, which means they have a higher processing cost but are much more flexible than static lighting. It is also the only entity except env_projectedtexture that can light up brushes in real-time (but it doesn't replace their original lighting).

Note.pngNote:This entity actually consists of two lights, a cone model light and a spot world light. Some values may affect one and not the other.
Note.pngNote:For the light to work properly, the "Maximum distance" keyvalue must be greater than the distance from the entity to the surface it is supposed to light, otherwise it will not show. Also, it is recommended to set the "Light brightness" keyvalue to either 6 or 8 as it typically looks best. Normal brightness values do not apply. Finally, adjusting the angle using the circle tool in the top-right or by using the "point at" tool will only adjust the cone model, the angle keyvalue must be set manually to adjust the spot world light.
Note.pngNote:For the 2013 SDK this is limited to 32 lights on at any one time so use wisely.
Note.pngNote:For modern games, it is recommended to use env_projectedtexture for more realistic and accurate dynamic lighting.
Icon-Bug.pngBug:Parented light_dynamic entities may not correctly light brushes; see the talk page.
Warning.pngWarning:This entity reduce performance, especially with small luxel scale for lightmaps and custom appearance. For example, in Black Mesa Black Mesa 2012 turrets make 30-40 FPS in some cases when fire, however in Black Mesa Black Mesa: Definitive Edition this entity use Wikipedia icon Deferred lighting, which does not cause performance problems in the cases.
Icon-Important.pngImportant:While this entity does exist in Black Mesa Black Mesa, it is very different from other games. Instead of using lightmaps it uses Wikipedia icon Deferred lighting. However, unlike Black Mesa's new lighting entities, it does not support specular reflections and dynamic shadows. This entity is used for some effects and entities, such as prop_flare or npc_alien_controller. Many inputs are missing, except TurnOff, TurnOn, Toggle and base entity inputs. Console commands (see below) for this entity don't work. Essentially this is cheap analogue of a newLight_Point.
An example Light_dynamic with different colors
An example in Black Mesa Black Mesa


Keyvalues


Targetname:
Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity to point at (target) <targetname>
The name of an entity in the map that the dynamic light will point at.
Light color (_light) <color255>
The RGB render color of the spotlight. Colors must be between 0 and 255.
Light brightness (brightness) <integer>
The intensity of the spotlight.
Inner (bright) angle (_inner_cone) <integer>
The angles of the inner spotlight beam. 0 makes it omnidirectional.
Outer (fading) angle (_cone) <integer>
The angles of the outer spotlight beam. 0 makes it omnidirectional.
Icon-Bug.pngBug:Broken in Black Mesa Black Mesa, use 0 to escape bug.
Example


Pitch (pitch) <integer>
Used instead of Pitch Yaw Roll's value for reasons unknown.
Maximum distance (distance) <float>
This is the distance that light is allowed to cast, in inches.
Spotlight end radius (spotlight_radius) <float>
This is the radius of the light, in inches, at the object that it is hitting.
Appearance (style) <choices>
Various Custom Appearance (see below) presets.
Light 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

Flags

  •  [1] : Do not light world (better perf)
Note.pngNote:Doesn't work in Black Mesa Black Mesa.
  •  [2] : Do not light models
Note.pngNote:Doesn't work in Black Mesa Black Mesa.
Warning.pngWarning:If enable - light source will not work in Black Mesa Black Mesa.
  •  [8] : Subtract Displacement Alpha
Note.pngNote:Doesn't work in Black Mesa Black Mesa.

Inputs

Color <color255>
Set the light's render color (R G B).
Note.pngNote:Not missed in Black Mesa Black Mesa, but it does nothing.
brightness <integer>
Set the light brightness.
distance <float>
Set the maximum light distance.
_inner_cone <integer>
Set the inner (bright) angle.
_cone <integer>
Set the outer (fading) angle.
spotlight_radius <float>
Set the radius of the spotlight at the end point.
style <integer>
Change the lightstyle (see Appearance field for possible values).
TurnOn
Turn the light off.
TurnOff
Turn the light on.
Toggle
Toggle the light on/off.

Console commands

r_dynamic <boolean>
Enables dynamic lights.
r_dynamiclighting <boolean>
Enables toggled lights.
r_maxdlights <integer>
Sets the maximum amount of dynamic lights.
r_portal_use_dlights <integer> (only in Portal 2)
Enables dynamic lights behind portals

See also