env_fade

From Valve Developer Community

This is a point entity available in all Source games.

Contents 1 Entity description 2 Keyvalues 3 Flags 4 Inputs 5 Outputs

Entity description

An entity that controls screen fades. Add duration and holdtime together for the total time this entity will be in effect.

The modulate flag on env_fade uses a different kind of blending to achieve the fade. The normal fade does a straight weighted blend between the screen and the fading color (i.e. the fade color becomes a more/less opaque overlay over the scene). Modulate actually attenuates the screen colors in RGB with the fade color. So you could, for example, remove all of the red and blue from a scene with modulate and be left with a green overlay - well, sort of night vision anyway. The fade color for that would be pure green with modulate.

Keyvalues

• Targetname:

• duration

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

• holdtime

<integer> The time to hold the faded in/out state.

• renderamt

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

• rendercolor

<color255> Fade Color

Flags

• 1 : Fade From

Essentially a "fade in," where the screen begins from an opaque color.

• 2 : Modulate

Use attenuation blending, see Entity Description.

• 4 : Personal

Only affect activator

• 8 : Stay Out

The fade remains indefinitely until another fade deactivates it.

Inputs

• Targetname:

• RenderFields:

• Fade

Start the screen fade.

Outputs

• Targetname:

• OnBeginFade

Fired when the fade has begun. (activator is the activator)