env_fade

GoldSrc

Source Engine

Class hierarchy
CEnvFade ↳CLogicalEntity ↳CServerOnlyEntity ↳CBaseEntity
EnvFade.cpp

env_fade is a logical entity available in all Source games.

It controls screen fades to or from a solid color. Add Duration and Hold Time together for the total time this entity will be in effect.

Bug:Doesn't work in Portal if player's health is below 100 due to the red screen.

Confirm:Is it in Portal 2 as well ?

Keyvalues

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

Duration (seconds) (duration) <string>

The time that it will take to fade the screen in or out.

Hold Fade (seconds) (holdtime) <string>

The time to hold the faded in/out state.

Fade Alpha (renderamt) <integer>

Alpha of the fade, where 0 = fully transparent and 255 = fully opaque.

Fade Color (R G B) (rendercolor) <color255>

Fade color.

Reverse Fade Duration (seconds) (ReverseFadeDuration) <float> (in all games since )

The duration of the reverse fade.

Flags

Fade From : [1]

Screen fades from the specified color instead of to it.

Modulate : [2]

Uses attenuation blending to achieve the fade. The normal fade does a straight weighted blend between the screen and the fading color. Modulate actually attenuates the RGB channels. For example, a color of 0 255 0 would mute the red and blue channels and create a green nightvision-type effect.

Triggering player only : [4] !FGD

Only affects the screen of the !activator. !activator is probably the easiest to reach through a trigger entity. If not checked, the fade will apply to all players.

Stay Out : [8]

Fade remains indefinitely until another fade deactivates it.

Bug:Fades applied to !activator only that are also set to Stay Out will not be deactivated by a new fade!  (tested in: )

Todo: Test in other games, test if the ScreenFade VScript function is also affected

Inputs

Fade

Start the screen fade.

FadeReverse  (in all games since )

Begin doing the reverse of the current fade.

Alpha  !FGD

Changes Fade Alpha.

Color  !FGD

Changes Fade Color.

Outputs

OnBeginFade

Fired when the fade has begun.

ConCommands

Cvar/Command	Parameters or default value	Descriptor	Effect
fadein	float int int int int	Time (seconds), Red, Green, Blue, Alpha	Makes the screen black (or the specified color), then fades to the normal view.
fadeout	float int int int int	Time (seconds), Red, Green, Blue, Alpha	Fades the screen to black (or the specified color).

Bug:Due to a mistake in the code, the alpha value isn't read properly from these commands; if you specify rgb it also has to be specified for the fade to work.