Light dynamic
From Valve Developer Community
This point-based entity is available in all Source games.
| Table of contents |
[edit]
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: 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 Light entities
[edit]
Keyvalues
- targetname <target_source>
- Defines the name that other entities refer to this entity by.
- hammerid [Episode Two Update]
- <integer readonly> This id is used for debugging purposes in Hammer.
- Pitch Yaw Roll (Y Z X)
- This entity's angular orientation in the world (also used for angular effect entities).
- This will control the direction the light points at, if no target is specified.
- parentname <target_destination>
- Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities mimic the movements of their Parent.
- target <target_destination>
- 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.
[edit]
Flags
- 1 : No World Light
- 2 : No Model Light
- 4 : Add Displacement Alpha
- 8 : Subtract Displacement Alpha
[edit]
Inputs
- Kill
- Removes this entity from the world.
- Removes this entity and all its children from the world.
- 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 == infinite)>
- Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.
- SetParent <target_destination>
- Changes the entity's parent in the movement hierarchy.
- SetParentAttachment <string>
- Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
- SetParentAttachmentMaintainOffset <string> [Episode One Update]
- Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.
- Removes this entity from its current movement hierarchy.
- 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.
