env_global_light

From Valve Developer Community
Revision as of 10:13, 4 January 2024 by WisdomBot (talk | contribs) (Updated old entity format to {{this is a}}. This action was perfomed by a bot.)
Jump to navigation Jump to search
English (en)Translate (Translate)
Env global light stockasw.jpg

env_global_light is an e0 available in Alien Swarm Alien Swarm. It casts a shadow map that follows the player. Nearly identical to sunlight_shadow_control.

The main difference from an env_projectedtexture is that this projects orthographically (like sunlight) instead of in a radial fashion (like a lightbulb).

C++ In code, it is represented by theCGlobalLightclass, defined in theenv_global_light.cppfile.

Dedicated Console Variables

{{varcom|cl_globallight_freeze|0|01|Freezes the env_global_light in place so that it won't follow the player.[confirm]
Cvar/Command Parameters or default value Descriptor Effect
cl_globallight_xoffset -800 Hammer units Offset from the player that the light originates from, along the X axis.
cl_globallight_yoffset 1600 Hammer units Offset from the player that the light originates from, along the Y axis.

Keyvalues

Light Color (color) ([todo internal name (i)]) <color255>
RGBA color of the sunlight.

{{KV|Color Transition Time (colortransitiontime)|float|This is the number of seconds it takes to get from 0 to 255.[Clarify]

Distance (distance) ([todo internal name (i)]) <float>
Height above the player where the projection originates from.
FOV (fov) ([todo internal name (i)]) <float>
This is the field of view that the sunlight casts in. Use lower values to simulate a more distant sun and sharper shadows.
NearZ Distance (nearz) ([todo internal name (i)]) <float>
Distance from the player where the near Z plane is. Anything closer to the projection origin

{{KV|North Offset (northoffset)|float|"This offsets the from the player position where the sun is attached."[Clarify]

Texture Name (texturename) ([todo internal name (i)]) <material>
The light texture which this entity projects.
Enable Shadows (enableshadows) ([todo internal name (i)]) <boolean>
Enables shadows. If shadows are disabled, light may appear to go through objects. Disabling shadows may be ideal for lower-detail environments due to being less expensive.
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 whether shadow maps are enabled

EnableDisable:

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


Outputs