Env fade: Difference between revisions
Jump to navigation
Jump to search
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.
CoeltAcace (talk | contribs) mNo edit summary |
MyGamepedia (talk | contribs) (Nothing to add I think.) |
||
| (59 intermediate revisions by 27 users not shown) | |||
| Line 1: | Line 1: | ||
[ | {{LanguageBar}} | ||
{{ | {{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}} | |||
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|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 == | == 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}} | |||
== Flags == | == Flags == | ||
{{fl|1|Fade From|Screen fades ''from'' the specified color instead of ''to'' it.}} | |||
{{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.}} | |||
{{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.}} | |||
{{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}} | |||
== Inputs == | == Inputs == | ||
{{I|Fade|Start the screen fade.}} | |||
{{I|FadeReverse|Begin doing the reverse of the current fade.|since=P2}} | |||
{{I|Alpha|nofgd=1|Changes '''Fade Alpha'''.}} | |||
{{I|Color|nofgd=1|Changes '''Fade Color'''.}} | |||
== Outputs == | == Outputs == | ||
{{O|OnBeginFade|Fired when the fade has begun.}} | |||
== ConCommands == | |||
{{varcom|start}} | |||
{{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.}} | |||
{{varcom|fadeout|float int int int int|Time (seconds), Red, Green, Blue, Alpha|Fades the screen to black (or the specified color).}} | |||
{{varcom|end}} | |||
{{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.}} | |||
[[Category:Entities]] | [[Category:GUI Entities]] | ||
Latest revision as of 05:47, 4 July 2025
 Class hierarchy
|
|---|
| CEnvFade |
| 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.
Confirm:
Keyvalues
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentnameortarget).
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 0would 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.
!activatoris 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 Outwill not be deactivated by a new fade! (tested in:
) - Todo: Test in other games, test if the
ScreenFadeVScript 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.