Env screenoverlay

From Valve Developer Community

This point-based entity is available in all Source games.

Table of contents

1 Entity description 2 Textures 3 Keyvalues 4 Flags 5 Inputs 6 Outputs 7 See also

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.

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

• targetname <target_source>

Defines the name that other entities refer to this entity by.

• hammerid [Episode Two Update]

<integer readonly> This id is used for debugging purposes in Hammer.

• 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

• Kill

Removes this entity from the world.

• KillHierarchy

Removes this entity and all its children from the world.

• AddOutput <string>

Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.

Format: <key> <value>

Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>

• FireUser1-4

Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.

• 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

• OnUser1-4

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.

!activator = activator

See also

• Overlays - A large list of overlays.