Cleanup is going to take awhile, so the site is back up but editing has been disabled.

Env screenoverlay

From HalfLife 2 Knowledge Base

Jump to: navigation, search

Contents

env_screenoverlay

Source(core) Point 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.


properties

  • Name targetname(target_source)
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    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) - default: 1.0
    Amount of time that the tenth overlay should be displayed for, after which this entity will stop displaying overlays.


spawn flags

none.


inputs

  • 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. Format
  • 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.


related tutorials

Submit your tutorial for env_screenoverlay

Personal tools