Skip to main content

func_areaportalwindow

Mesh Entity

An entity that can be used to optimize the visibility in a map. If you seal off an area with them, when the viewer moves the specified distance away from them, they will go opaque and the parts inside the area will not be drawn. The 'target' brush model should enclose the func_areaportal window so no parts of it are culled by the window. If you use the optional foreground brush model, then it should enclose the 'target' brush model.

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.

  • Rendered Window (target) <TargetDestination>
    The name of a brush model to render as the window.

  • Fade Start Distance (FadeStartDist) <Integer>
    When the viewer is closer than this distance, the alpha is set to 'TranslucencyLimit'.

  • Fade End Distance (FadeDist) <Integer>
    When the viewer is at this distance, the portal becomes solid and closes off.

  • Translucency limit (TranslucencyLimit) <String>
    This value limits the translucency of the bmodel and prevents it from becoming invisible when the viewer is right on top of it.

  • Foreground bmodel (BackgroundBModel) <String>
    (Optional) brush model that is drawn after the fading brush model. This model should have alpha in its textures so you can see through it.

  • Portal Version (PortalVersion) <Integer>
    (Don't change). Differentiates between shipping HL2 maps and maps using new engine features.

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.

  • SetFadeStartDistance <Integer>
    Set fade start distance.

  • SetFadeEndDistance <Integer>
    Set fade end distance.

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.