Env screenoverlay

env_screenoverlay in practice using effects/combine_binocoverlay

Entity description

An entity that can display and control a set of screen overlays, to be displayed over the player's view. Useful for view effects like drunkenness, or teleporter afterimages, etc.

Note:An overlay will be applied to all players in multiplayer games.

Materials

You can use any material as an overlay, but UnlitGeneric ones are recommended to avoid artefacting.

Valve provide these materials in the /effects folder:

combine_binocoverlay

Combine binoculars

tp_eyefx/tpeye

Green teleport shimmer

tp_eyefx/tpeye2

Red teleport shimmer

tp_eyefx/tpeye3

Blue teleport shimmer

tp_eyefx/tp_eyefx

Drugged distortion

tp_eyefx/tp_black

Black. A probable bug makes it so that a thin border around the overlay is still visible.

tp_eyefx/tp_eyefx_eli

Flashing animation of three figures. Hardly usable as an overlay.

These materials are not designed as screen overlays, but will work as one:

debug/yuv

Monochrome (Black and white)

effects/com_shield002a.vmt

The combine shield shader effect - refraction with drifting squares.

models/effects/portalfunnel_sheet

Red-yellow-green scrolling ground overlay

models/props_combine/portalball001_sheet

Green downward haze

effects/tp_refract

Red/Orange Refractive overlay

Keyvalues

Name (targetname) <string>[ Edit ]

The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.

See also:  Generic Keyvalues, Inputs and Outputs available to all entities

• OverlayName(1-10)

<material> Name of the overlay material to display.

• OverlayTime(1-10)

<float> Amount of time that the overlay should be displayed for, after which it will begin showing the next overlay.

Flags

• 1 : Allow Suit Zoom

Inputs

• StartOverlays

Start displaying the first overlay.

• StopOverlays

Stop displaying any overlays.

• SwitchOverlay <integer>

Switch to displaying a specific overlay. Pass in the desired overlay number in the parameter. Entering -1 as the value will cause the overlay to display indefinitely.

See also

• Overlays - A large list of overlays.