Env screenoverlay: Difference between revisions
Jump to navigation
Jump to search
m (Noted -1 causes the overlay to display indefinitely) |
m (minoro) |
||
| Line 3: | Line 3: | ||
[[Image:env_screenoverlay.jpg|thumb|300px|right|env_screenoverlay in practice using effects/combine_binocoverlay]] | [[Image:env_screenoverlay.jpg|thumb|300px|right|env_screenoverlay in practice using effects/combine_binocoverlay]] | ||
==Entity | == 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. | 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== | == Textures == | ||
You can use any texture as an overlay, but these standard textures are meant to work with this entity: | You can use any texture as an overlay, but these standard textures are meant to work with this entity: | ||
| Line 45: | Line 43: | ||
|} | |} | ||
==Keyvalues== | == Keyvalues == | ||
* {{kv targetname}} | * {{kv targetname}} | ||
* '''OverlayName''(1-10)''''' | * '''OverlayName''(1-10)''''' | ||
: <material> Name of the overlay material to display. | : <material> Name of the overlay material to display. | ||
* '''OverlayTime''(1-10)''''' | * '''OverlayTime''(1-10)''''' | ||
: <float> Amount of time that the overlay should be displayed for, after which it will begin showing the next overlay. | : <float> Amount of time that the overlay should be displayed for, after which it will begin showing the next overlay. | ||
==Flags== | == Flags == | ||
* 1 : Allow Suit Zoom | * 1 : Allow Suit Zoom | ||
==Inputs== | == Inputs == | ||
* {{i targetname}} | * {{i targetname}} | ||
* '''StartOverlays''' | * '''StartOverlays''' | ||
: Start displaying the first overlay. | : Start displaying the first overlay. | ||
* '''StopOverlays''' | * '''StopOverlays''' | ||
: Stop displaying any overlays. | : Stop displaying any overlays. | ||
* '''SwitchOverlay <integer>''' | * '''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. | : 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== | == Outputs == | ||
* {{o targetname}} | |||
* | == See also == | ||
* [[Overlays]] - A large list of overlays. | |||
[[Category:Entities]] | [[Category:Entities]] | ||
[[Category:Special Effects]] | [[Category:Special Effects]] | ||
[[Category:Abstract Mapping]] | [[Category:Abstract Mapping]] | ||
Revision as of 04:42, 1 February 2008
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 useable 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 | Monocrome (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
See also
- Overlays - A large list of overlays.