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 (→‎Inputs: Substituted IO templates)
(position in the world irrelevant so it's logical entity)
Line 1: Line 1:
<!-- When this page is updated to {{langsp}} or {{langsp}} instead of {{lang}}, please move {{this is a}} to the base page, as it is automatically translated. -->{{lang|Env screeneffect}}{{CD|CEnvScreenEffect|file1=env_screenoverlay.cpp}}
{{LanguageBar}}
{{this is a|point entity|name=env_screeneffect}} It allows screenspace effects to be played on the player's view.
{{CD|CEnvScreenEffect|file1=env_screenoverlay.cpp}}
{{This is a|logical entity|name=env_screeneffect}} It allows screenspace effects to be played on the player's view.


{{bug|Does not function in {{tf2}}{{portal2}}.}}
{{bug|Does not function in {{tf2}}{{portal2}}.}}
{{bug|Causes a memory leak in {{l4d2}} by spamming garbage data to the console, do not use this entity for that game!}}
{{bug|Causes a memory leak in {{l4d2}} by spamming garbage data to the console, do not use this entity for that game!}}


==Keyvalues==
== Keyvalues ==
{{KV Targetname}}
{{KV Targetname}}
{{KV|Effect Type|intn=type|choices|Which effect to use.
{{KV|Effect Type|intn=type|choices|Which effect to use.
Line 12: Line 13:
:*2: Groggy Vision}}
:*2: Groggy Vision}}


==Inputs==
== Inputs ==
{{I|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}}
{{I|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 04:28, 29 April 2025

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

env_screeneffect is a logical 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.