Skip to main content

env_screenoverlay

Point Entity

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.

Keyvalues

  • Entity Scripts (vscripts) <ScriptList>
    Name(s) of script files that are executed after all entities have spawned.

  • Name (targetname) <TargetSource>
    The name that other entities refer to this entity by.

  • Overlay Name 1 (OverlayName1) <String>
    Name of the first overlay material to display.

  • Overlay Duration 1 (OverlayTime1) <Float>
    Amount of time that the first overlay should be displayed for, after which it will begin showing the second overlay.

  • Overlay Name 2 (OverlayName2) <String>
    Name of the second overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 2 (OverlayTime2) <Float>
    Amount of time that the second overlay should be displayed for, after which it will begin showing the third overlay.

  • Overlay Name 3 (OverlayName3) <String>
    Name of the third overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 3 (OverlayTime3) <Float>
    Amount of time that the third overlay should be displayed for, after which it will begin showing the fourth overlay.

  • Overlay Name 4 (OverlayName4) <String>
    Name of the fourth overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 4 (OverlayTime4) <Float>
    Amount of time that the fourth overlay should be displayed for, after which it will begin showing the fifth overlay.

  • Overlay Name 5 (OverlayName5) <String>
    Name of the fifth overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 5 (OverlayTime5) <Float>
    Amount of time that the fifth overlay should be displayed for, after which it will begin showing the sixth overlay.

  • Overlay Name 6 (OverlayName6) <String>
    Name of the sixth overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 6 (OverlayTime6) <Float>
    Amount of time that the sixth overlay should be displayed for, after which it will begin showing the seventh overlay.

  • Overlay Name 7 (OverlayName7) <String>
    Name of the seventh overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 7 (OverlayTime7) <Float>
    Amount of time that the seventh overlay should be displayed for, after which it will begin showing the eighth overlay.

  • Overlay Name 8 (OverlayName8) <String>
    Name of the eighth overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 8 (OverlayTime8) <Float>
    Amount of time that the eighth overlay should be displayed for, after which it will begin showing the ninth overlay.

  • Overlay Name 9 (OverlayName9) <String>
    Name of the ninth overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 9 (OverlayTime9) <Float>
    Amount of time that the ninth overlay should be displayed for, after which it will begin showing the tenth overlay.

  • Overlay Name 10 (OverlayName10) <String>
    Name of the tenth overlay material to display. If left blank, overlay displaying will finish, and this entity will consider itself done.

  • Overlay Duration 10 (OverlayTime10) <Float>
    Amount of time that the tenth overlay should be displayed for, after which this entity will stop displaying overlays.

Inputs

  • RunScriptFile <String>
    Load and execute a script file

  • RunScriptCode <String>
    Execute a fragment of script code

  • CallScriptFunction <String>
    Call a script function

  • CallPrivateScriptFunction <String>
    Calls a script function from this entity's private script scope.

  • CallGlobalScriptFunction <String>
    Calls a script function in the global script scope.

  • Kill <Void>
    Removes this entity from the world.

  • KillHierarchy <Void>
    Removes this entity and all its children from the world.

  • AddOutput <String>
    Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care.

  • FireUser1 <Void>
    Causes this entity's OnUser1 output to be fired.

  • FireUser2 <Void>
    Causes this entity's OnUser2 output to be fired.

  • FireUser3 <Void>
    Causes this entity's OnUser3 output to be fired.

  • FireUser4 <Void>
    Causes this entity's OnUser4 output to be fired.

  • StartOverlays <Void>
    Start displaying the first overlay.

  • StopOverlays <Void>
    Stop displaying any overlays.

  • SwitchOverlay <Float>
    Switch to displaying a specific overlay. Pass in the desired overlay number in the parameter.

Outputs

  • OnUser1 <Void>
    Fired in response to FireUser1 input.

  • OnUser2 <Void>
    Fired in response to FireUser2 input.

  • OnUser3 <Void>
    Fired in response to FireUser3 input.

  • OnUser4 <Void>
    Fired in response to FireUser4 input.

  • OnKilled <Void>
    Fired when the entity is killed and removed from the game.