Env fade: Difference between revisions
Jump to navigation
Jump to search
URAKOLOUY5 (talk | contribs) No edit summary |
(-added class hierarchy) |
||
| Line 1: | Line 1: | ||
{{lang|title=env_fade}} | {{lang|title=env_fade}} | ||
{{infotable | {{infotable | ||
|env_fade | |env_fade | ||
| Line 8: | Line 7: | ||
|in=0 | |in=0 | ||
}} | }} | ||
{{CD|CEnvFade|file1=EnvFade.cpp}} | |||
{{entity|env_fade|type=e0}} 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. | {{entity|env_fade|type=e0}} 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. | ||
==Keyvalues== | ==Keyvalues== | ||
Revision as of 18:11, 27 August 2023
| env_fade | |
|---|---|
 | |
| Type | Point entity |
| Engine |  Source |
| Availability | In all games |
 Class hierarchy
|
|---|
| CEnvFade |
| EnvFade.cpp
|
Template:Entity 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.
Keyvalues
- 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.Template:ModernBug - Template:ModernTodo
- Stay Out : [8]
- Fade remains indefinitely until another fade deactivates it.
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). |