This article's documentation is for anything that uses the Source engine. Click here for more information.

Env fade: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(updates)
(Nothing to add I think.)
 
(29 intermediate revisions by 13 users not shown)
Line 1: Line 1:
{{lang|Env fade}}
{{LanguageBar}}
[[File:env_fade.png|left|link=]]{{base point|env_fade}} 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.
{{TabsBar|main=gs|base=env_fade}}
[[File:env_fade.png|left|link=]]
{{CD|CEnvFade|file1=EnvFade.cpp}}
{{This is a|logical entity|name=env_fade}}


{{code class|CEnvFade|EnvFade.cpp}}
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.


{{clr}}
{{bug|Doesn't work in {{portal|4}} if player's health is below 100 due to the red screen.{{confirm|Is it in {{portal2|4}} as well ?}}|hidetested={{portal}}}}
<br>
<br>
<br>
__TOC__
== Keyvalues ==
{{KV Targetname}}
{{KV|Duration (seconds) |intn=duration|string|The time that it will take to fade the screen in or out.}}
{{KV|Hold Fade (seconds) |intn=holdtime|string|The time to hold the faded in/out state.}}
{{KV|Fade Alpha |intn=renderamt|integer|Alpha of the fade, where 0 {{=}} fully transparent and 255 {{=}} fully opaque.}}
{{KV|Fade Color (R G B) |intn=rendercolor|color255|Fade color.}}
{{KV|Reverse Fade Duration (seconds) |intn=ReverseFadeDuration|float|The duration of the reverse fade.|since=P2}}


==ConVars/Commands==
== Flags ==  
{{varcom|start}}
{{fl|1|Fade From|Screen fades ''from'' the specified color instead of ''to'' it.}}
{{varcom|fadein|float int int int 0|Time (seconds), Red, Green, Blue, {{todo}}|Makes the screen black (or the specified color), then fades to the normal view. {{todo|Why is the last number required?}}}}
{{fl|2|Modulate|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 <code>0 255 0</code> would mute the red and blue channels and create a green nightvision-type effect.}}
{{varcom|fadeout|float int int int 0|Time (seconds), Red, Green, Blue, {{todo}}|Fades the screen to black (or the specified color). {{todo|Why is the last number required?}}}}
{{fl|4|nofgd=1|Triggering player only| Only affects the screen of the {{ent|!activator}}. <code>!activator</code> is probably the easiest to reach through a [[trigger]] entity. If not checked, the fade will apply to all players.}}
{{varcom|end}}
{{fl|8|Stay Out|Fade remains indefinitely until another fade deactivates it.{{Bug|tested={{tf2}}|Fades applied to {{ent|!activator}} only that are also set to <Code>Stay Out</code> will not be deactivated by a new fade!}}}}
:{{todo|Test in other games, test if the <code>ScreenFade</code> VScript function is also affected}}


==Flags==  
== Inputs ==
*1: Fade From - Screen fades ''from'' the specified color instead of ''to'' it.
{{I|Fade|Start the screen fade.}}
*2: Modulate - 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 <code>0 255 0</code> would mute the red and blue channels and create a green nightvision-type effect.
{{I|FadeReverse|Begin doing the reverse of the current fade.|since=P2}}
*4: Triggering player only {{not in FGD}} - Only affects the screen of the {{ent|!activator}}. <code>!activator</code> is probably the easiest to reach through a [[trigger]] entity. If not checked, the fade will apply to all players.
{{I|Alpha|nofgd=1|Changes '''Fade Alpha'''.}}
*8: Stay Out - Fade remains indefinitely until another fade deactivates it.
{{I|Color|nofgd=1|Changes '''Fade Color'''.}}


==Keyvalues==
== Outputs ==
{{KV|Duration (seconds) (duration)|string|The time that it will take to fade the screen in or out.}}
{{O|OnBeginFade|Fired when the fade has begun.}}
{{KV|Hold Fade (seconds) (holdtime)|string|The time to hold the faded in/out state.}}
{{KV|Fade Alpha (renderamt)|integer|Alpha of the fade, where 0 {{=}} fully transparent and 255 {{=}} fully opaque.}}
{{KV|Fade Color (R G B) (rendercolor)|color255|Fade color.}}
{{KV|Reverse Fade Duration (seconds) (ReverseFadeDuration)|float|The duration of the reverse fade.|since=P2}}
{{KV BaseEntity|css=1}}


==Inputs==
== ConCommands ==
{{IO|Fade|Start the screen fade.}}
{{varcom|start}}
{{IO|FadeReverse|Begin doing the reverse of the current fade.|since=P2}}
{{varcom|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.}}
{{IO|Alpha|nofgd=1|Changes '''Fade Alpha'''.}}
{{varcom|fadeout|float int int int int|Time (seconds), Red, Green, Blue, Alpha|Fades the screen to black (or the specified color).}}
{{IO|Color|nofgd=1|Changes '''Fade Color'''.}}
{{varcom|end}}
{{I BaseEntity|prel4d=1}}
{{bug|hidetested=1|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.}}
 
==Outputs==
{{IO|OnBeginFade|Fired when the fade has begun.}}
{{O BaseEntity|l4d=1}}


[[Category:GUI Entities]]
[[Category:GUI Entities]]

Latest revision as of 05:47, 4 July 2025

English (en)Русский (ru)中文 (zh)Translate (Translate)
Env fade.png
C++ Class hierarchy
CEnvFade
↳CLogicalEntity
↳CServerOnlyEntity
↳CBaseEntity
C++ EnvFade.cpp

env_fade is a logical entity available in all Source 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.

Icon-Bug.pngBug:Doesn't work in Portal Portal if player's health is below 100 due to the red screen.
Confirm:Is it in Portal 2 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 Portal 2)
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.
Icon-Bug.pngBug:Fades applied to !activator only that are also set to Stay Out will not be deactivated by a new fade!  (tested in: Team Fortress 2)
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 Portal 2)
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).
Icon-Bug.pngBug: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.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_fade&oldid=484814"