env_fade
12-Jul-2023
Point entity which, when triggered, causes the players' screens to have an in- or out-fading color to be drawn over them. It's possible to create static screen color modulation by retriggering this entity in a loop.
Keyvalues |
OnDestroy Function ondestroyfn : Name of the function to use from already parsed .as script files when entity is destroyed (killed) in any way. If the function belongs to namespace, you must use prefix with the namespace name (e.g. mynamespace::MyFunction) for the keyvalue.
Name targetname : Set name of env_fade so other entities can trigger it to start fade effect. Every trigger use-type works uniformly. Triggering fade that is in progress restarts fade. Can be kill-targeted but fade effect will play to it's end.
Duration (seconds) duration : Time, in seconds, the effect will fade in/out.
Hold Fade (seconds) holdtime : Time, in seconds, the fully faded-in/not yet faded-out state will stay.
Fade Alpha renderamt : Set how transparent/opaque the effect is at its peak (Hold fade). 0 means transparent. 255 means opaque.
Fade Color (R G B) rendercolor : The color to use.
Flags
-
1 : Fade From : If set, instead of fading to the color specified, the screen will fade out from it, meaning the color will apply suddenly. Good for a flashbang effect.
-
2 : Modulate : If set, instead of drawing the color layer over the screen, the color you set will be used as a color filter. E.g., when you set the color to pure green, any red and blue will be removed from the player's screen.
-
4 : Activator Only : If set, only the player who activated this entity will be affected by it.
Sum of "Duration" and "Hold Fade" time can be maximum ~18 seconds long, then env_fade ends. Trigger it multiple times to keep it for longer time, use more than one env_fade if you need first one for color transition, and second one for still target color.
