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

func_areaportal

From Valve Developer Community
Jump to: navigation, search
Not to be confused with linked_portal_door (Portal 2 An unrelated entity, sometimes referred to as a "world portal").
English (en)Hrvatski (hr)Русский (ru)中文 (zh)Translate (Translate)
Class hierarchy
CAreaPortal
CFuncAreaPortalBase
CBaseEntity
func_areaportal.cpp
Toolsareaportal.gif

func_areaportal is a brush entity available in all Source Source games. It creates an areaportal, used to manage visibility in maps. When the portal is open it stops objects not visible through it from rendering; when the portal is closed it cannot be seen through at all.

These are not really brush entities. They are brush entities from a mapper/Hammer perspective, but by the time they reach the game, the brush is gone and this is, in effect, a point entity.

While it is not necessary for the entity to function, the texture tools\toolsareaportal (seen on the left) is intended to be used on areaportals.

Keyvalues

Name (targetname) <string>
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

Name of Linked Door (target) <targetname>
A prop_door_rotating or func_door whose open/closed state controls the on/off state of the portal. This is optional.
Initial State (StartOpen) <boolean>
Initial state of the portal.

Inputs

Open
Sets the portal to the open state.
Close
Sets the portal to the closed state.
Toggle
Opens the portal if closed. Closes the portal if open.

See also