shadow_control

From Valve Developer Community
Revision as of 00:06, 18 November 2019 by Deprecated (talk | contribs) (Added GMOD availablity for L4D keyvalues, added note about local light shadows)

Jump to: navigation, search
简体中文
Shadow control.png
shadow_control is a point entity available in all Source games. It defines the direction, color and attenuation distance of the dynamic shadows created by light_environment for the entire map.
Note:Since <Left 4 Dead> (and in <Garry's Mod>), shadow direction can be determined by local lights instead of a global value. See below for more details.

The properties of this entity apply to the whole map. Multiple instances of this entity within a map may cause errors.

Confirm:Obsolete in <Counter-Strike: Global Offensive>? Possibly replaced by env_cascade_light.

Keyvalues

Shadow Color (color) <color255>
This is the color of the shadows.
Maximum Distance (distance) <float>
This is the maximum distance the shadow is allowed to cast, in inches.
Tip:Shortening this distance can be used to approximate the effects of diffuse lighting.
All Shadows Disabled (disableallshadows) <boolean>
Disable shadows entirely.
Enable Local Light Shadows (enableshadowsfromlocallights) <boolean> (New with Left 4 Dead) (Also in Garry's Mod)
Enable shadow direction to be calculated on a per-entity basis and to be dictated by the light closest to the entity.
Note:This keyvalue may not be available in some FGDs.

Angles:

Pitch Yaw Roll (Y Z X) <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.
Tip:Pitch is the sun's angle of elevation from the ground, and yaw is its compass bearing.

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
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.

Inputs

color <color255>
Set the shadow color.
direction <vector>
Set the shadow direction.
SetDistance <float>
Set the maximum shadow cast distance.
SetAngles <string>
Set the shadow direction.
SetShadowsDisabled <integer>
Set shadows disabled state.
SetShadowsFromLocalLightsEnabled <integer> (New with Left 4 Dead) (Also in Garry's Mod)
Set local light shadows enabled state.
Note:This input may not be available in some FGDs.

Targetname:

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 than Kill.
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.
SetLocalOrigin <coordinates> (New with Alien Swarm) !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> (New with Alien Swarm) !FGD
Set this entity's angles.

Outputs

Base:

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.

See Also