Env screenoverlay

An env_screenoverlay with effects/combine_binocoverlay on d2_coast_03.

Template:Base point It 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, even when the !activator is one player. To apply an overlay to a single client, the command r_screenoverlay <material_path> (requires sv_cheats 1, except for ) needs to be used with a point_clientcommand.

Note:In , screen overlays are disabled by default. You must set r_drawscreenoverlay 1 to enable.

Bug: Any material applied will flicker, even UnlitGeneric ones.  [todo tested in ?]

In code, it is represented by theCEnvScreenOverlayclass, defined in theenv_screenoverlay.cppfile.

Materials

You can use any material as an overlay, but UnlitGeneric materials are the least likely to have any visual bugs.

Valve provides 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

Warped distortion, somewhat similar the one seen on strider charge shots.

tp_eyefx/tp_black

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

glass/glasswindow_refract01

As if looking through a glass Observation window from Portal

Flags

• 1: Allow Suit Zoom

Keyvalues

Overlay Name 1 (OverlayName1) ([todo internal name (i)]) to Overlay Name 10 (OverlayName10) <string>

Name of the first overlay material to display.

Overlay Duration 1 (OverlayTime1) ([todo internal name (i)]) to Overlay Duration 10 (OverlayTime10) <float>

Amount of time that the overlay should be displayed for, after which it will begin showing the next overlay. Setting this to -1 will make the entity display the overlay indefinitely, until it's forced to change by an input.

Inputs

StartOverlays

Start displaying the first overlay.

StopOverlays

Stop displaying any overlays.

SwitchOverlay <integerRedirectInput/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

• Video with some overlays.