Difference between revisions of "Shadow control"
From Valve Developer Community
Deprecated (talk | contribs) (Added notes that Left 4 dead added keyvalue and input may not be available in some FGDs, re-ordered Angles keyvalue block) |
Deprecated (talk | contribs) (Added GMOD availablity for L4D keyvalues, added note about local light shadows) |
||
| Line 2: | Line 2: | ||
|zh-cn=Shadow_control:zh-cn | |zh-cn=Shadow_control:zh-cn | ||
}} | }} | ||
| − | |||
{{base point|shadow_control|sprite=1}} It defines the direction, color and attenuation distance of the [[Dynamic Shadows|dynamic shadows]] created by {{ent|light_environment}} for the entire map. | {{base point|shadow_control|sprite=1}} It defines the direction, color and attenuation distance of the [[Dynamic Shadows|dynamic shadows]] created by {{ent|light_environment}} for the entire map. | ||
| + | {{Note|Since {{l4d}} (and in {{GMOD}}), shadow direction can be determined by local lights instead of a global value. See below for more details.}} | ||
{{map_properties}} | {{map_properties}} | ||
| Line 15: | Line 15: | ||
{{KV|All Shadows Disabled (disableallshadows)|boolean|Disable shadows entirely.}} | {{KV|All Shadows Disabled (disableallshadows)|boolean|Disable shadows entirely.}} | ||
{{KV|Enable Local Light Shadows (enableshadowsfromlocallights)|boolean|Enable shadow direction to be calculated on a per-entity basis and to be dictated by the light closest to the entity. | {{KV|Enable Local Light Shadows (enableshadowsfromlocallights)|boolean|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 [[FGD]]s.}}|since=L4D}} | + | : {{Note|This keyvalue may not be available in some [[FGD]]s.}}|since=L4D|also=GMOD}} |
{{KV Angles}} | {{KV Angles}} | ||
: {{tip|Pitch is the sun's angle of elevation from the ground, and yaw is its compass bearing.}} | : {{tip|Pitch is the sun's angle of elevation from the ground, and yaw is its compass bearing.}} | ||
| Line 27: | Line 27: | ||
{{IO|SetShadowsDisabled|Set shadows disabled state.|param=integer}} | {{IO|SetShadowsDisabled|Set shadows disabled state.|param=integer}} | ||
{{IO|SetShadowsFromLocalLightsEnabled|Set local light shadows enabled state. | {{IO|SetShadowsFromLocalLightsEnabled|Set local light shadows enabled state. | ||
| − | : {{Note|This input may not be available in some [[FGD]]s.}}|param=integer|since=L4D}} | + | : {{Note|This input may not be available in some [[FGD]]s.}}|param=integer|since=L4D|also=GMOD}} |
{{I Targetname}} | {{I Targetname}} | ||
== Outputs == | == Outputs == | ||
| − | {{O | + | {{O BaseEntity}} |
== See Also == | == See Also == | ||
Revision as of 00:06, 18 November 2019
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 
(and in 
), 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 
? Possibly replaced by env_cascade_light.Contents
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>(in all games since) (also in ) - 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)
(angles)<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
(targetname)<string> - The targetname that other entities refer to this entity by.
- Entity Scripts
(vscripts)<scriptlist>(in all games since
) - 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
(thinkfunction)<string>(in all games since) - 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>(in all games since) (also in ) - Set local light shadows enabled state.
- Note:This input may not be available in some FGDs.
Targetname:
-
Kill - Removes this entity from the world.
-
KillHierarchy - Removes this entity and its children from the world. Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than
Kill. -
AddOutput<string> - Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format:<key> <value>
I/O Format:<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite> -
FireUser1toFireUser4 - Fire the
OnUseroutputs; see User Inputs and Outputs. -
Use!FGD - Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.
-
RunScriptFile<script>(in all games since) - Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
-
RunScriptCode<string>(in all games since) - 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 , 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>(in all games since) !FGD - Execute a VScript function in the scope of the receiving entity.
-
SetLocalOrigin<coordinates>(in all games since
) !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>(in all games since) !FGD - Set this entity's angles.
Outputs
Base:
-
OnUser1toOnUser4 - These outputs each fire in response to the firing of the like-numbered
FireUser1toFireUser4Input; see User Inputs and Outputs.
