This article's documentation is for Source 2. Click here for more information.

env_spherical_vignette

From Valve Developer Community
Jump to: navigation, search

env_spherical_vignette is a point entity available in Half-Life: Alyx Half-Life: Alyx.

Enabled and disabled in the same scene

Entity description

The env_spherical_vignette is a point entity which acts similar to gradient fog but can be placed in set locations rather than being attached to the player. The Fog itself is cast radially from the entity origin and can fade seamlessly over mesh geometry both static and dynamic.

Properties

Source 2 Transform:

Origin (origin) <coordinates>
The world space origin of the entity.
Angles (angles) <angles>
The pitch, yaw, roll orientation of the entity.
Scale (scales) <vector>
The x, y, z scales of the entity. Not all entities can use this.
Transform Locked (transform locked) <boolean>
Lock the transform at its current value, preveting the transform of the node from being modified.
Force Hidden (force hidden) <boolean>
Visually hides the entity from the viewports. The Outliner pane will still list hidden entities.
Editor Only (editor only) <boolean>
Entity is only displayed in Hammer and will not appear in game.


Name ([todo internal name (i)]) <string>
The name that other entities refer to this entity by.
Misc Entity Scripts ([todo internal name (i)]) <string>
Name(s) of script files that are executed after all entities have spawned.
Start Disabled ([todo internal name (i)]) <boolean>
Self Explanatory
Vignette Start Distance ([todo internal name (i)]) <float>
Default 30.0
Vignette End Distance ([todo internal name (i)]) <float>
Default 120.0
Far Z ([todo internal name (i)]) <float>
Vignette Maximum Opacity ([todo internal name (i)]) <float>
Default 1.0
Vignette Color (R G B) ([todo internal name (i)]) <color255>
Default (0 0 0)
Vignette Strength ([todo internal name (i)]) <float>
Default 1.0
Vignette Falloff Exponent ([todo internal name (i)]) <float>
Exponent for distance falloff. (Default 1.0)
Fade Time ([todo internal name (i)]) <float>
How much time it takes to fade in new values. (Default 1.0)

Outputs

OnKilled
Fire when the entity is killed and removed from the game.
OnUser1
Fired in response to FireUser1 input
OnUser2
Fired in response to FireUser2 input
OnUser3
Fired in response to FireUser3 input
OnUser4
Fired in response to FireUser4 input

Inputs

AlyxTargetName:
RunScriptFile
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.


RunScriptCode
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.


CallScriptFunction
Execute a VScript function in the scope of the receiving entity.


CallPrivateScriptFunction
Execute a VScript function from this entity's private script scope


CallGlobalScriptFunction
Execute a VScript function from the global script scope


Kill
Removes this entity from the world.


KillHierarchy
Removes this entity and its children from the world.
Note.pngNote:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.


AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>


FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Enable
Enable this entity.
Disable
Disable this entity.
Disable
Disable this entity.
SetVignetteStartDistance
Set vignette start distance
SetVignetteEndDistance
Set vignette end distance
SetVignetteMaxOpacity
Set vignette max opacity
SetVignetteFalloffExponent
Set vignette falloff exponent
SetVignetteColor
Set vignette color
SetVignetteStrength
Set vignette strength

See also