env_fade
... 
This page needs to be translated.
This page either contains information that is only partially or incorrectly translated, or there isn't a translation yet.
If this page cannot be translated for some reason, or is left untranslated for an extended period of time after this notice is posted, the page should be requested to be deleted.
| env_fade | |
|---|---|
 | |
| Type | Point entity |
| Engine |  Source |
| Availability | In all games |
env_fade is a point entity available in all Source games.
Создаёт затемнение экрана. Screen fades are used to blend regular game imagery to or from a solid color. 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.
Contents
Keyvalues
- Duration (seconds)
(???)<string> - The time that it will take to fade the screen in or out.
- Hold Fade (seconds)
(???)<string> - The time to hold the faded in/out state.
- Fade Alpha
(???)<integer> - Alpha of the fade, where 0 = fully transparent and 255 = fully opaque.
- Fade Color (R G B)
(???)<color255> - Fade color.
- Reverse Fade Duration (seconds)
(???)<float> (in all games since
) - The duration of the reverse fade.
Targetname:
- Name
(targetname)<string> - The targetname that other entities refer to this entity by.
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 : Triggering player only
(in all games since 
)
- Only affect activator
- 8 : Stay Out
- The fade remains indefinitely until another fade deactivates it. This prevents the ondeath-fadeout used in Portal 2.
Inputs
Fade- Start the screen fade.
FadeReverse(in all games since)- Begin doing the reverse of the current fade.
Base:
AddContext<string>- Adds to the entity's list of response contexts. See Context.
AddOutput<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext- Removes all contexts from this entity's list.
ClearParent- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1toFireUser4- Fires the respective
OnUseroutputs; see User Inputs and Outputs.
Kill- Removes this entity and any entities parented to it from the world.
KillHierarchy- Functions the same as
Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKillinput.
RemoveContext<string>- Remove a context from this entity's list. The name should match the key of an existing context.
SetParent<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment<string>- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset<string>- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
DispatchResponse<string> !FGD- Dispatches a response to the entity. See Response and Concept.
DispatchEffect<string> (removed since
) !FGD- Dispatches a special effect from the entity's origin; See also List of Client Effects. Replaced by the particle system since .
RunScriptFile<script> (in all games since
) (also in 
)- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode<string> (in all games since) (also in )- Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug:In Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.
Fix:Remove the string argument manually with a text editor.Note: Backtick characters ` are replaced with quotation marks at runtime, allowing quotation marks to be used when normally not possible.
CallScriptFunction<string> (in all games since) (also in ) !FGD- Calls a VScript function defined in the scope of the receiving entity.
TerminateScriptScope(only in) !FGD- Destroys the script scope of the receving entity.
SetLocalOrigin<coordinates> (in all games since) !FGD- Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
Outputs
OnBeginFade- Fired when the fade has begun. (
!activatoris the activator)
Targetname:
OnUser1toOnUser4- These outputs each fire in response to the firing of the like-numbered
FireUser1toFireUser4Input; see User Inputs and Outputs.
OnKilled(only in)- This output fires when the entity is killed and removed from the game.
