Env fade: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
{{wrongtitle|title=env_fade}}
{{wrongtitle|title=env_fade}}
==Entity Description==
==Entity Description==
An entity that controls screen fades.
An entity that controls screen fades.  Add '''duration''' and '''holdtime''' together for the total time this entity will be in effect.
==Keyvalues==
==Keyvalues==
* {{kv targetname}}
* {{kv targetname}}
Line 13: Line 13:
: {{color}} Fade Color
: {{color}} Fade Color
==Flags==
==Flags==
* 1 : Fade From
* 1 : Fade From - Essentially a "fade in," where the screen begins from an opaque color.
* 2 : Modulate
* 2 : Modulate - Use attenuation blending, see [[#Notes|Notes]].
* 8 : Stay Out
* 8 : Stay Out - The fade remains indefinitely until another fade deactivates it.


==Inputs==
==Inputs==
Line 27: Line 27:
* '''OnBeginFade'''
* '''OnBeginFade'''
: Fired when the fade has begun.
: Fired when the fade has begun.
==Notes==
from Jay Stelly:
: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 fade's 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 "nightvision" display - well, sort of nightvision anyway. The fade color for that would be pure green with modulate.
[[Category:Entities]]
[[Category:Entities]]

Revision as of 20:23, 12 November 2005

Template:Wrongtitle

Entity Description

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

Keyvalues

<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
#000000 Fade Color

Flags

  • 1 : Fade From - Essentially a "fade in," where the screen begins from an opaque color.
  • 2 : Modulate - Use attenuation blending, see Notes.
  • 8 : Stay Out - The fade remains indefinitely until another fade deactivates it.

Inputs

Start the screen fade.

Outputs

Fired when the fade has begun.

Notes

from Jay Stelly:

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 fade's 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 "nightvision" display - well, sort of nightvision anyway. The fade color for that would be pure green with modulate.