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

Sunlight shadow control: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Changed parameters of {{this is a}} to comply with the updated version. This action was performed by a bot.)
m (→‎Inputs: Substituted IO templates)
Line 22: Line 22:


== Inputs ==
== Inputs ==
{{IO|LightColor|Set the light color.|param=color255}}
{{I|LightColor|Set the light color.|param=color255}}
{{IO|SetAngles|Set the sun direction.|param=string}}
{{I|SetAngles|Set the sun direction.|param=string}}
{{IO|SetDistance|Set the distance of the sun.|param=float}}
{{I|SetDistance|Set the distance of the sun.|param=float}}
{{IO|SetFOV|Set the field of view the sun casts.|param=float}}
{{I|SetFOV|Set the field of view the sun casts.|param=float}}
{{IO|SetNearZDistance|Set the near z distance.|param=float}}
{{I|SetNearZDistance|Set the near z distance.|param=float}}
{{IO|SetNorthOffset|Sets the north offset.|param=float}}
{{I|SetNorthOffset|Sets the north offset.|param=float}}
{{IO|SetTexture|Set the texture cookie of the sunlight.|param=string}}
{{I|SetTexture|Set the texture cookie of the sunlight.|param=string}}
{{IO|EnableShadows|Set the if shadows are enabled|param=boolean}}
{{I|EnableShadows|Set the if shadows are enabled|param=boolean}}
{{I Targetname}}
{{I Targetname}}
{{I EnableDisable}}
{{I EnableDisable}}

Revision as of 23:08, 20 April 2025

sunlight_shadow_control is a point entity available in all Source Source games since Alien Swarm Alien Swarm.

Entity description

Shadow control.png

An entity to control the sunlight that casts shadows in the map. Nearly identical to env_global_light in both function and appearance.


Keyvalues

Pitch Yaw Roll (Y Z X) ([todo internal name (i)]) <string>
This is the light cast direction. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, and roll is the rotation around the X axis.
Light Color ([todo internal name (i)]) <color255>
This is the color of the sunlight.
Color Transition Time ([todo internal name (i)]) <float>
This is the number of seconds it takes to get from 0 to 255.
Distance ([todo internal name (i)]) <float>
This is the distance of the sun, greater distances produce more orthogonal shadows.
FOV ([todo internal name (i)]) <float>
This is the field of view that the sunlight casts in. Use lower values for more distant sun and sharper shadows.
NearZ Distance ([todo internal name (i)]) <float>
This controls the near clipping plane's distance from the player.
North Offset ([todo internal name (i)]) <float>
This offsets the from the player position where the sun is attached.
Texture Name ([todo internal name (i)]) <material>
Enable Shadows ([todo internal name (i)]) <boolean>
Enables/disables shadows from this projected texture.
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

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Inputs

LightColor <color255RedirectInput/color32>
Set the light color.
SetAngles <stringRedirectInput/string>
Set the sun direction.
SetDistance <floatRedirectInput/float>
Set the distance of the sun.
SetFOV <floatRedirectInput/float>
Set the field of view the sun casts.
SetNearZDistance <floatRedirectInput/float>
Set the near z distance.
SetNorthOffset <floatRedirectInput/float>
Sets the north offset.
SetTexture <stringRedirectInput/string>
Set the texture cookie of the sunlight.
EnableShadows <booleanRedirectInput/boolean>
Set the if shadows are enabled

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

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