This article's documentation is for anything that uses the Source engine. Click here for more information.

Env screeneffect: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Changed parameters of {{this is a}} to comply with the updated version. This action was performed by a bot.)
m (→‎Inputs: Substituted IO templates)
Line 13: Line 13:


==Inputs==
==Inputs==
{{IO|StartEffect|Start the effect with the duration in seconds as the passed parameter.|param=float}}
{{I|StartEffect|Start the effect with the duration in seconds as the passed parameter.|param=float}}
{{IO|StopEffect|Fade out the effect over the duration in seconds as the passed parameter.|param=float}}
{{I|StopEffect|Fade out the effect over the duration in seconds as the passed parameter.|param=float}}


[[Category:GUI Entities]]
[[Category:GUI Entities]]

Revision as of 10:53, 21 April 2025

English (en)Translate (Translate)
C++ Class hierarchy
CEnvScreenEffect
CPointEntity
CBaseEntity
C++ env_screenoverlay.cpp

env_screeneffect is a point entity available in all Source Source games. It allows screenspace effects to be played on the player's view.

Icon-Bug.pngBug:Does not function in Team Fortress 2Portal 2.  [todo tested in ?]
Icon-Bug.pngBug:Causes a memory leak in Left 4 Dead 2 by spamming garbage data to the console, do not use this entity for that game!  [todo tested in ?]

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

Effect Type (type) <choices>
Which effect to use.
  • 0: Advisor Stun
  • 1: Intro Blur
  • 2: Groggy Vision

Inputs

StartEffect <floatRedirectInput/float>
Start the effect with the duration in seconds as the passed parameter.
StopEffect <floatRedirectInput/float>
Fade out the effect over the duration in seconds as the passed parameter.