Light dynamic: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Cleanup)
Line 1: Line 1:
{{wrongtitle|title=light_dynamic}}
{{base point|light_dynamic}} 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.
{{base_point}}
 
==Entity Description==
 
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.


{{note|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|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.}}
Line 10: Line 5:
{{note|For the light to work properly the "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, the "brightness" keyvalue should be either 6 or 8, 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|For the light to work properly the "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, the "brightness" keyvalue should be either 6 or 8, 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.}}


* See also [[Lighting]] and [[List_of_entities#Light_Entities|Light entities]]
== Keyvalues ==
 
{{KV|Entity to point at|target_destination|The name of an entity in the map that the dynamic light will point at.}}
==Keyvalues==
{{KV|Light color|color255|The RGB render color of the spotlight. Colors must be between 0 and 255.}}
 
{{KV|Light brightness|integer|The intensity of the spotlight.}}
* {{KV Targetname}}
{{KV|Inner (bright) angle|integer|The angles of the inner spotlight beam.}}
{{KV|Outer (fading) angle|integer|The angles of the outer spotlight beam.}}
{{KV|Pitch|integer|Used instead of Pitch Yaw Roll's value for reasons unknown. }}
{{KV|Maximum distance|float|This is the distance that light is allowed to cast, in inches.}}
{{KV|Spotlight end radius|float|This is the radius of the light, in inches, at the object that it is hitting.}}
{{KV|Appearance|choices|Various Custom Appearance ([[#Appearances|see below]]) presets.}}
{{KV Targetname}}
{{KV Parentname}}
{{KV Angles}}


* {{KV Angles}}
=== Appearances ===
: This will control the direction the light points at, if no target is specified.
{{light appearances}}


* {{KV Parentname}}
== Flags ==
 
* 1 : Do not light world (better perf)
* '''target <target_destination>'''
* 2 : Do not light models
: The name of an entity in the map that the dynamic light will point at.
 
* '''inner_cone <integer>'''
: The inner (bright) angle.
 
* '''cone <integer>'''
: The outer (fading) angle.
 
* '''brightness <integer>'''
: This is the intensity of the spotlight.
 
* '''spotlight_radius <float>'''
: This is the radius of the spotlight, in inches, at the object that it is hitting.
 
==Flags==
 
* 1 : No World Light (Better Performance)
* 2 : No Model Light
* 4 : Add Displacement Alpha
* 4 : Add Displacement Alpha
* 8 : Subtract Displacement Alpha
* 8 : Subtract Displacement Alpha


==Inputs==
==Inputs==
{{IO|Color|Set the light's render color (R G B).|param=color255}}
{{IO|brightness|Set the light brightness.|param=integer}}
{{IO|distance|Set the maximum light distance.|param=float}}
{{IO|_inner_cone|Set the inner (bright) angle.|param=integer}}
{{IO|_cone|Set the outer (fading) angle.|param=integer}}
{{IO|spotlight_radius|Set the radius of the spotlight at the end point.|param=float}}
{{IO|style|Change the lightstyle (see Appearance field for possible values).|param=integer}}
{{IO|TurnOn|Turn the light off.}}
{{IO|TurnOff|Turn the light on.}}
{{IO|Toggle|Toggle the light on/off.}}
{{I Targetname}}
{{I Parentname}}


* {{I Targetname}}
== See also ==
 
* [[Lighting]]
* {{I Parentname}}
* [[List_of_entities#Light_Entities|Light entities]]
 
* '''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.


[[Category:Lighting]]
[[Category:Lighting]]

Revision as of 06:26, 27 July 2011

Template:Base point 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.

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 "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, the "brightness" keyvalue should be either 6 or 8, 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.

Keyvalues

Entity to point at ([todo internal name (i)]) <targetname>
The name of an entity in the map that the dynamic light will point at.
Light color ([todo internal name (i)]) <color255>
The RGB render color of the spotlight. Colors must be between 0 and 255.
Light brightness ([todo internal name (i)]) <integer>
The intensity of the spotlight.
Inner (bright) angle ([todo internal name (i)]) <integer>
The angles of the inner spotlight beam.
Outer (fading) angle ([todo internal name (i)]) <integer>
The angles of the outer spotlight beam.
Pitch ([todo internal name (i)]) <integer>
Used instead of Pitch Yaw Roll's value for reasons unknown.
Maximum distance ([todo internal name (i)]) <float>
This is the distance that light is allowed to cast, in inches.
Spotlight end radius ([todo internal name (i)]) <float>
This is the radius of the light, in inches, at the object that it is hitting.
Appearance ([todo internal name (i)]) <choices>
Various Custom Appearance (see below) presets.
Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Parentname:
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.
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.

Appearances

Template:Light appearances

Flags

  • 1 : Do not light world (better perf)
  • 2 : Do not light models
  • 4 : Add Displacement Alpha
  • 8 : Subtract Displacement Alpha

Inputs

Color <color255RedirectInput/color32>
Set the light's render color (R G B).
brightness <integerRedirectInput/integer>
Set the light brightness.
distance <floatRedirectInput/float>
Set the maximum light distance.
_inner_cone <integerRedirectInput/integer>
Set the inner (bright) angle.
_cone <integerRedirectInput/integer>
Set the outer (fading) angle.
spotlight_radius <floatRedirectInput/float>
Set the radius of the spotlight at the end point.
style <integerRedirectInput/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.


Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/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 <stringRedirectInput/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.

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Light_dynamic&oldid=156041"