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.

Textures

You can use any texture as an overlay, but these standard textures are meant to work with this entity:

Texture	Attempts at description
effects/combine_binocoverlay.vmt	Combine binoculars
effects/tp_eyefx/tpeye.vmt	Green teleport shimmer
effects/tp_eyefx/tpeye2.vmt	Red teleport shimmer
effects/tp_eyefx/tpeye3.vmt	Blue teleport shimmer
effects/tp_eyefx/tp_eyefx.vmt	Drugged distortion
effects/tp_eyefx/tp_black.vmt	Black*
effects/tp_eyefx/tp_eyefx_eli.vmt	Flashing animation of three figures. Hardly usable as an overlay.

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

These are also good overlays:

Texture	Attempts at description
debug/yuv.vmt	Monochrome (Black and white)
effects/com_shield002a.vmt	"Moving wet screen"
models/effects/portalfunnel_sheet.vmt	"Red-yellow-green scrolling ground overlay"
models/props_combine/portalball001_sheet.vmt	"Green downward haze"

Keyvalues

• Template:Kv targetname
• 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

• Template:I targetname
• 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.

Outputs

• Template:O targetname

See also

• Overlays - A large list of overlays.