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

env_spherical_vignette

From Valve Developer Community
Jump to navigation Jump to search
Enabled and disabled in the same scene

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

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

Vignette Start Distance (vignettestart) <float>
Default 30.0
Vignette End Distance (vignetteend) <float>
Default 120.0
Far Z (farz) <float>
Vignette Maximum Opacity (vignettemaxopacity) <float>
Default 1.0
Vignette Color (R G B) (vignettecolor) <color255>
Default (0 0 0)
Vignette Strength (vignettestrength) <float>
Default 1.0
Vignette Falloff Exponent (vignettefalloffexponent) <float>
Exponent for distance falloff. (Default 1.0)
Fade Time (fadetime) <float>
How much time it takes to fade in new values. (Default 1.0)
Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).
Source 2 Targetname
Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist>
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Create Client-Only Entity (clientSideEntity) <choices>
  1. No
  2. Yes
Source 2 Transform
Note.pngNote: These are "Embedded Properties" which are hard-coded to appear on every entity in Hammer, regardless of their presence in any FGD files.
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 (transformLocked) <boolean>
Lock the transform at its current value, preventing the transform of the node from being modified. Only applies within Hammer.
Force Hidden (force_hidden) <boolean>
Visually hides the entity from the viewports. The Outliner pane will still list hidden entities.
Editor Only (editorOnly) <boolean>
Entity is only displayed in Hammer and will not appear in game.

Inputs

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

EnableDisable:

Enable / Disable <void>
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

Source 2 Targetname
Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist>
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Create Client-Only Entity (clientSideEntity) <choices>
  1. No
  2. Yes

See also