Func areaportal: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Removed old link.)
m (Directed links and fixed typos.)
Line 2: Line 2:


== Entity Description ==
== Entity Description ==
Creates an [[area portal]], used to manage visibility in maps. Portals define areas, or spaces that are connected in the map. Both sides of a portal cannot touch the same area, for example, a doughnut-shaped map would require at least two portals to divide the map into two areas. A linear map could be divided into two areas with a single area portal.
Creates an [[areaportal]], used to manage visibility in maps. Portals define areas, or spaces that are connected in the map. Both sides of a portal cannot touch the same area, for example, a doughnut-shaped map would require at least two portals to divide the map into two areas. A linear map could be divided into two areas with a single areaportal.


* Behavior with linked doors can be tricky.  If the areaportal is doing the opposite of what it should, closing when the door is open and vice versa, change the areaportal's initial state.
* Behavior with linked doors can be tricky.  If the areaportal is doing the opposite of what it should, closing when the door is open and vice versa, change the areaportal's initial state.
* Areaportals do not take into account geometry between the portal volume and the player when considering visibility.
* Areaportals do not take into account geometry between the portal volume and the player when considering visibility.


To learn how area portals work, see [[area portal]]. For a tutorial on the subject, see [[area portal tutorial]].
To learn how areaportals work, see [[areaportal]]. For a tutorial on the subject, see [[areaportal tutorial]].




Line 15: Line 15:


* '''target'''
* '''target'''
: <target_destination> (Optional) The name of a door whose open/closed state controls the on/off state of this area portal.
: <target_destination> (Optional) The name of a door whose open/closed state controls the on/off state of this areaportal.


* '''StartOpen'''
* '''StartOpen'''
Line 36: Line 36:


== See also ==
== See also ==
* [[area portal]]
* [[areaportal]]
* [[area portal tutorial]]
* [[areaportal tutorial]]
* [[func_areaportalwindow]]
* [[func_areaportalwindow]]


[[Category:Entities]] [[Category:Brush Entities]]
[[Category:Entities]] [[Category:Brush Entities]]

Revision as of 19:48, 16 September 2007

Template:Wrongtitle

Entity Description

Creates an areaportal, used to manage visibility in maps. Portals define areas, or spaces that are connected in the map. Both sides of a portal cannot touch the same area, for example, a doughnut-shaped map would require at least two portals to divide the map into two areas. A linear map could be divided into two areas with a single areaportal.

  • Behavior with linked doors can be tricky. If the areaportal is doing the opposite of what it should, closing when the door is open and vice versa, change the areaportal's initial state.
  • Areaportals do not take into account geometry between the portal volume and the player when considering visibility.

To learn how areaportals work, see areaportal. For a tutorial on the subject, see areaportal tutorial.


Keyvalues

  • target
<target_destination> (Optional) The name of a door whose open/closed state controls the on/off state of this areaportal.
  • StartOpen
<boolean> Choose the initial state of this entity.

Inputs

  • Open
Open the portal. When the portal is open is can be seen through.
  • Close
Close the portal. When the portal is closed it cannot be seen through.
  • Toggle
Toggle the open/closed state of the portal.

Outputs

See also