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").
Underlinked - Logo.png
This article needs more links to other articles to help integrate it into the encyclopedia. Please help improve this article by adding links that are relevant to the context within the existing text.
January 2024


English (en)русский (ru)中文 (zh)
... Icon-Important.png
class hierarchy
CAreaPortal defined in func_areaportal.cpp
CFuncAreaPortalBase
CBaseEntity
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.

The entity's brush must be textured with tools\toolsareaportal (seen on the left) for it to function.

Keyvalues

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.

Targetname:
Name (targetname) <string>
The targetname that other entities refer to this entity by.

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