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

Func areaportal: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
m (Add Portal Version keyvalue)
 
(46 intermediate revisions by 26 users not shown)
Line 1: Line 1:
[http://ndr.hu/rhodes/flcvln.html pc game and computer world] [http://www.salona-yachts.eu/misc/jorobb.html la it girl] [http://troniny.ovh.org/gallery/layout/leqvfl.html adult interactive video] [http://www.stillwaterhomes.com/listings/images/pic/pmirfr.html acrylic cover table] [http://troniny.ovh.org/gallery/layout/lvlkkg.html skilled worker program canada] [http://www.lowell.edu/styles/old_style/css/wgpccm.html maintenance products corporation] [http://www.olemissfans.com/chatpro/image/lferkx.html ip address location software] [http://2001.c3.hu/mas/fmwgri.html net office php] [http://www.olemissfans.com/chatpro/image/xtxpaa.html 1850 theatre] [http://kristinlyseggen.com/gallery/1documentaries/7travel/vbvimr.html secrets in laces] [http://activeimage.c3.hu/css/qrixdk.html secured transactions outline] [http://www.salona-yachts.eu/misc/bbwxlc.html man s search for meaning] [http://aura.c3.hu/thumb/snbgae.html indiana bankruptcy record] [http://2001.c3.hu/mas/ogngox.html planes of wwii] [http://kom-pas.de/3xcms/config/hkatuploads/images/lsrtvv.html texas rehabilitation comm] [http://www.easypayinfo.com/subscribe/tmp/viggvx.html absurd good news] [http://maps.my2gig.com/cache/ieukaw.html lost fan sites] [http://www.easypayinfo.com/subscribe/tmp/vwwlbq.html 7 year old birthday parties] [http://www.stillwaterhomes.com/listings/images/pic/ffrwuf.html she wants to move mp3] [http://www.systemsupport.und.edu/cache/avatars/emo/nplsgo.html tenuate] [http://www.olemissfans.com/chatpro/image/dviwqs.html root seed steps take] [http://troniny.ovh.org/gallery/layout/sstemq.html joe bergen] [http://www.farmelco.hu/test/css/iamirc.html ultimate fighter workouts] [http://mkatzenbach.de/Website_MK_alt/content/cache/dir/end001/njqlqf.html parts for rca television] [http://troniny.ovh.org/gallery/layout/tqstop.html away message art pictures] [http://www.plurpage.com/classifieds/cache/hgnhrh.html 18k chain] [http://www.olemissfans.com/chatpro/image/hkabhw.html 10 codec download media player window] [http://activeimage.c3.hu/css/kpkrjs.html legal redress] [http://www.systemsupport.und.edu/cache/avatars/emo/rcawfl.html window basic tutorial] [http://www.plurpage.com/classifieds/cache/bjmcct.html 1992 la riot] [http://www.salona-yachts.eu/misc/rqwqea.html new video release dates] [http://www.systemsupport.und.edu/cache/avatars/emo/bheopg.html download metal ringtones] [http://aura.c3.hu/thumb/swnpin.html 2000 olympic games sydney] [http://aura.c3.hu/thumb/pxpqkp.html north carolina state department of education] [http://kom-pas.de/3xcms/config/hkatuploads/images/nfhuhq.html school blackboard] [http://aura.c3.hu/thumb/rflbub.html sexy celebrity poster] [http://ndr.hu/rhodes/hxurvn.html a gantt chart] [http://kristinlyseggen.com/gallery/1documentaries/7travel/wsokhe.html 2006 hopeful oscar] [http://informer.siam.edu/themes/hm/japwfe.html cheap hydrocodone] [http://kom-pas.de/3xcms/config/hkatuploads/images/luprrv.html prohibition in canada] [http://ndr.hu/rhodes/lraqtr.html research and development job] [http://2001.c3.hu/mas/mmscbg.html alice cooper dead baby] [http://activeimage.c3.hu/css/hofdow.html 12 ball valve] [http://2001.c3.hu/mas/xwqdhe.html tied up girlfriends] [http://aura.c3.hu/thumb/clrepd.html liers] [http://aura.c3.hu/thumb/tbvxes.html toy cannon] [http://kristinlyseggen.com/gallery/1documentaries/7travel/slksui.html monotony] [http://maps.my2gig.com/cache/ehndba.html microsoft product support service] [http://www.salona-yachts.eu/misc/gmkvpf.html smart funny quotes] [http://kom-pas.de/3xcms/config/hkatuploads/images/bbcjpe.html nursing salaries in australia] [http://www.plurpage.com/classifieds/cache/lltbxw.html writing prompts 3rd] [http://ndr.hu/rhodes/chwcrb.html monkey see monkey doo] [http://www.salona-yachts.eu/misc/bqfghu.html lapas] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/jgeisn.html buy levitra] [http://ndr.hu/rhodes/mrjrka.html what is bpo] [http://www.salona-yachts.eu/misc/bxglqv.html taipei towers] [http://aura.c3.hu/thumb/vbvdsl.html my uploads] [http://2001.c3.hu/mas/reapcj.html sugar and spice models] [http://kom-pas.de/3xcms/config/hkatuploads/images/opqvni.html will and testament free download] [http://troniny.ovh.org/gallery/layout/pfarne.html kensington cables] [http://activeimage.c3.hu/css/etdrvb.html job for 14 year old] [http://www.easypayinfo.com/subscribe/tmp/vphscf.html illinois comprehensive health insurance plan] [http://www.easypayinfo.com/subscribe/tmp/umjgji.html st louis mo radio station] [http://kom-pas.de/3xcms/config/hkatuploads/images/itgrwl.html liquid vitamin for kid] [http://mkatzenbach.de/Website_MK_alt/content/cache/dir/end001/pfhdfq.html virals ads] [http://www.farmelco.hu/test/css/eqceio.html likes me when im gone] [http://2001.c3.hu/mas/dhgpcl.html the or fondue or french] [http://maps.my2gig.com/cache/eeefjj.html adult height weight average] [http://www.plurpage.com/classifieds/cache/iofmpt.html model arabian horses] [http://kristinlyseggen.com/gallery/1documentaries/7travel/pqignw.html new home in las vegas nevada] [http://troniny.ovh.org/gallery/layout/iepxpf.html wv counties map] [http://troniny.ovh.org/gallery/layout/jgsguv.html seaside highschool] [http://www.stillwaterhomes.com/listings/images/pic/xfajcm.html a listing of hotels in myrtle beach south carolina] [http://ndr.hu/rhodes/iibeve.html quick snooker games] [http://2001.c3.hu/mas/icsqnk.html sf soup co] [http://troniny.ovh.org/gallery/layout/qcttwa.html online medical info] [http://www.salona-yachts.eu/misc/kxdxji.html princely states] [http://www.systemsupport.und.edu/cache/avatars/emo/jkhlrw.html travis band website] [http://www.stillwaterhomes.com/listings/images/pic/cjtnlg.html in in inclusion introduction proposal research school] [http://www.stillwaterhomes.com/listings/images/pic/mxkwxi.html a net passport] [http://aura.c3.hu/thumb/pfelet.html virals ads] [http://aura.c3.hu/thumb/txwxos.html angeles business ca in licensing los requirement] [http://kom-pas.de/3xcms/config/hkatuploads/images/rgalld.html voucher definition] [http://mkatzenbach.de/Website_MK_alt/content/cache/dir/end001/fkpqdu.html reinstall ie6 windows 2000] [http://aura.c3.hu/thumb/dvqxcr.html student rush tickets new york] [http://www.stillwaterhomes.com/listings/images/pic/robkkn.html rvs blue book value] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/upiclw.html rolex replica watches] [http://maps.my2gig.com/cache/trbeei.html momentum units] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/uidnvx.html download retro ringtones] [http://www.salona-yachts.eu/misc/cxbadu.html the oxford club investing] [http://mkatzenbach.de/Website_MK_alt/content/cache/dir/end001/mkvwgk.html online worksheets with solutions] [http://kom-pas.de/3xcms/config/hkatuploads/images/dgmpom.html university of kentucky chemistry department] [http://www.lowell.edu/styles/old_style/css/etjmjf.html amoxicillin online] [http://aura.c3.hu/thumb/gpwena.html post secondary recruitment government of canada] [http://www.olemissfans.com/chatpro/image/vofpjm.html utterly and completely] [http://www.easypayinfo.com/subscribe/tmp/alpltv.html apartment la maison] [http://troniny.ovh.org/gallery/layout/sreuqi.html wild woods lodge] [http://mkatzenbach.de/Website_MK_alt/content/cache/dir/end001/pgtrlv.html orthopaedic research society annual meeting] [http://aura.c3.hu/thumb/krgrbx.html sued by the debt collector] [http://www.lowell.edu/styles/old_style/css/amtvkp.html venice rome]
{{LanguageBar}}
{{wrongtitle|title=func_areaportal}}
{{distinguish|linked_portal_door|desc1={{p2}} An unrelated entity, sometimes referred to as a "world portal"}}


== 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.
{{CD|CAreaPortal|file1=func_areaportal.cpp}}
* Areaportals do not take into account geometry between the portal volume and the player when considering visibility.
{{This is a|semi-internal=1|brush entity|name=func_areaportal|sprite=Toolsareaportal.gif}} 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.
 
To learn how areaportals work, see [[areaportal]]. For a tutorial on the subject, see [[areaportal tutorial]].


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 {{Tooltip|line=dashed|It will work the same if textured with a world texture, Nodraw, or trigger textures|not necessary for the entity to function}}, the texture [[Tool_textures_(Source)#Optimization|tools/toolsareaportal]] (seen on the left) is intended to be used on areaportals.


== Keyvalues ==
== Keyvalues ==
* {{kv targetname}}
{{KV Targetname}}
 
{{KV|Name of Linked Door|intn=target|targetname|A entity (usually {{ent|prop_door_rotating}} or {{ent|func_door}}) whose open/closed state controls the on/off state of the portal. This is optional.}}
* '''target'''
{{KV|Initial State|intn=StartOpen|bool|Initial state of the portal.}}
: <target_destination> (Optional) The name of a door whose open/closed state controls the on/off state of this areaportal.
{{KV|Portal Version|intn=PortalVersion|integer|since={{Source 2006}}|Read-only version number that differentiates between shipping HL2 maps and maps using new engine features.}}
 
:* 0 : Backwards-compatible with Source 2004 (also called "shipping Half-Life 2 era")
* '''StartOpen'''
:* 1 : New and default version
: {{boolean}} Choose the initial state of this entity.


== Inputs ==
== Inputs ==
* {{i targetname}}
{{I|Open|Sets the portal to the open state.}}
 
{{I|Close|Sets the portal to the closed state.}}
* '''Open'''
{{I|Toggle|Opens the portal if closed. Closes the portal if 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 ==
* {{o targetname}}


== See also ==
== See also ==
* {{ent|func_areaportalwindow}}
* [[areaportal]]
* [[areaportal]]
* [[areaportal tutorial]]
* [[Optimization/Level_Design|Optimization (Level Design)]]
* [[func_areaportalwindow]]


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

Latest revision as of 11:35, 18 August 2025

English (en)Hrvatski (hr)Русский (ru)中文 (zh)Translate (Translate)
Not to be confused with linked_portal_door (Portal 2 An unrelated entity, sometimes referred to as a "world portal").


C++ Class hierarchy
CAreaPortal
CFuncAreaPortalBase
CBaseEntity
C++ func_areaportal.cpp
Toolsareaportal.gif

func_areaportal is a semi-internal 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>[ Edit ]
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 entity (usually 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.
Portal Version (PortalVersion) <integer> (in all games since Source 2006)
Read-only version number that differentiates between shipping HL2 maps and maps using new engine features.
  • 0 : Backwards-compatible with Source 2004 (also called "shipping Half-Life 2 era")
  • 1 : New and default version

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