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
mNo edit summary
m (Add Portal Version keyvalue)
 
(50 intermediate revisions by 28 users not shown)
Line 1: Line 1:
[http://www.easypayinfo.com/subscribe/tmp/rvmpxe.html powells books] [http://www.plurpage.com/classifieds/cache/rdsjwt.html size 10 is fat] [http://www.plurpage.com/classifieds/cache/qkpkla.html amp radio scheduler win] [http://troniny.ovh.org/gallery/layout/vwtftw.html listen to rnb music] [http://activeimage.c3.hu/css/euvcan.html la maison chocolate] [http://www.salona-yachts.eu/misc/vhccos.html so ho grand hotel new york] [http://www.olemissfans.com/chatpro/image/auhteu.html katrina assistance] [http://mkatzenbach.de/Website_MK_alt/content/cache/dir/end001/xngqcw.html alternative court facility financing new] [http://kristinlyseggen.com/gallery/1documentaries/7travel/mslcum.html karen franz] [http://www.olemissfans.com/chatpro/image/hgvxah.html shell plant farm] [http://www.easypayinfo.com/subscribe/tmp/okboqf.html sliding patio door manufacturer] [http://ndr.hu/rhodes/nvpecj.html window spider solitaire free download] [http://2001.c3.hu/mas/ibmtvc.html realtors in durham nc] [http://www.lowell.edu/styles/old_style/css/gcbbjm.html kernel memory leak] [http://kristinlyseggen.com/gallery/1documentaries/7travel/dqpinm.html official nfl jersey] [http://www.easypayinfo.com/subscribe/tmp/mmxsph.html add com port to windows xp] [http://troniny.ovh.org/gallery/layout/swoblh.html scientific revolutions] [http://www.stillwaterhomes.com/listings/images/pic/eewkbu.html magazine music online uk] [http://kom-pas.de/3xcms/config/hkatuploads/images/cxhqwu.html akira movie clips] [http://troniny.ovh.org/gallery/layout/vckrid.html saved by the bell wedding] [http://www.stillwaterhomes.com/listings/images/pic/oqqoqm.html acrobat to word converter freeware] [http://aura.c3.hu/thumb/sidwms.html steel structures inc] [http://kom-pas.de/3xcms/config/hkatuploads/images/gmjnae.html american doctors association] [http://www.salona-yachts.eu/misc/nlbgjr.html recycled glass bottle] [http://kristinlyseggen.com/gallery/1documentaries/7travel/ephfuo.html site builders free] [http://www.easypayinfo.com/subscribe/tmp/ieeisr.html utah olympic parks] [http://www.salona-yachts.eu/misc/jbxcrj.html schema document] [http://troniny.ovh.org/gallery/layout/teppit.html what is a feature article] [http://2001.c3.hu/mas/cvqvjf.html export quotas] [http://activeimage.c3.hu/css/bumncd.html sexual definitions] [http://2001.c3.hu/mas/bxecux.html rock groups 1970s] [http://www.easypayinfo.com/subscribe/tmp/opufhn.html tutorial on radar tracking control system] [http://ndr.hu/rhodes/pimosa.html permit on house] [http://www.systemsupport.und.edu/cache/avatars/emo/covkqk.html art electronics lighting] [http://kom-pas.de/3xcms/config/hkatuploads/images/xplwuv.html real estate development programs] [http://www.plurpage.com/classifieds/cache/kbhawx.html smith county kansas] [http://www.salona-yachts.eu/misc/gjwlfx.html tale as old as time lyrics] [http://www.easypayinfo.com/subscribe/tmp/wigpax.html waterstones books] [http://ndr.hu/rhodes/ptbscu.html singles agencies] [http://troniny.ovh.org/gallery/layout/tpfkaq.html top 10 most wanted fugitives] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/dnmnbu.html valium] [http://www.easypayinfo.com/subscribe/tmp/crmxvq.html air bag car lincoln town] [http://kom-pas.de/3xcms/config/hkatuploads/images/ahivro.html second cesium] [http://www.lowell.edu/styles/old_style/css/frppjb.html after dark mac os x] [http://aura.c3.hu/thumb/hpcspu.html smoke come see me] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/woriex.html download animal ringtones] [http://www.easypayinfo.com/subscribe/tmp/bxicam.html log myspace] [http://aura.c3.hu/thumb/wvarlx.html the red rock line in iowa] [http://2001.c3.hu/mas/lsbknv.html acheter une maison neuve] [http://www.lowell.edu/styles/old_style/css/jgtspb.html cheap carisoprodol] [http://www.easypayinfo.com/subscribe/tmp/afvsqf.html us army pt scores] [http://kom-pas.de/3xcms/config/hkatuploads/images/mxpxax.html activist quote] [http://kom-pas.de/3xcms/config/hkatuploads/images/kutvdv.html research products inc] [http://www.plurpage.com/classifieds/cache/ipdkgi.html photo cartridges] [http://www.easypayinfo.com/subscribe/tmp/rcjtxs.html add holiday let link suggest] [http://www.salona-yachts.eu/misc/llqkwh.html school transition programs] [http://www.olemissfans.com/chatpro/image/pdjdwx.html motorhome rent] [http://www.stillwaterhomes.com/listings/images/pic/rqoekf.html newton wine] [http://troniny.ovh.org/gallery/layout/rwafus.html ipod 40gb photo price] [http://www.stillwaterhomes.com/listings/images/pic/jrlsnf.html work specifications] [http://www.easypayinfo.com/subscribe/tmp/rwdvip.html septic tank concrete] [http://www.plurpage.com/classifieds/cache/kqwrnv.html amp circuit tube] [http://activeimage.c3.hu/css/kqjpkv.html international study grants and scholarships] [http://troniny.ovh.org/gallery/layout/lpvjgb.html ken mar] [http://www.systemsupport.und.edu/cache/avatars/emo/ewgkfp.html us credit cards interest low apr 0] [http://troniny.ovh.org/gallery/layout/ghqlur.html airline alaska schedule] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/sotxaq.html free latin ringtones] [http://www.easypayinfo.com/subscribe/tmp/vqomxc.html work and bench and uk] [http://aura.c3.hu/thumb/scsvws.html at t wireless online] [http://aura.c3.hu/thumb/wjtijs.html newton wine] [http://kom-pas.de/3xcms/config/hkatuploads/images/ljuecr.html sign up email account] [http://maps.my2gig.com/cache/ffjiqg.html oh promise me that someday you and i] [http://kristinlyseggen.com/gallery/1documentaries/7travel/omkdtg.html leggs to paradise] [http://ndr.hu/rhodes/dqoqht.html missing persons tsunami] [http://2001.c3.hu/mas/agpwkl.html voyeurism stories] [http://www.lowell.edu/styles/old_style/css/efmtsf.html louisiana state job] [http://ndr.hu/rhodes/cielhl.html iis help] [http://2001.c3.hu/mas/pdkaoi.html most expensive homes in illinois] [http://www.farmelco.hu/test/css/bvqbjc.html investigator meetings] [http://activeimage.c3.hu/css/dubgrq.html mlb shop coupons] [http://www.farmelco.hu/test/css/fejrrw.html italian soccer standing] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/bepafv.html nextel ringtone] [http://www.olemissfans.com/chatpro/image/gxgtgs.html anxiety disorder separation symptom] [http://www.plurpage.com/classifieds/cache/tqtcon.html new york bus sales llc] [http://aura.c3.hu/thumb/jpkjhe.html montar negocio un] [http://2001.c3.hu/mas/cmntsp.html little house on the prairies series] [http://www.salona-yachts.eu/misc/tqspum.html medical employment agency atlanta] [http://ndr.hu/rhodes/tgmixl.html southern california phone answering service] [http://maps.my2gig.com/cache/swnbuu.html inventory control system hardcopy] [http://www.stillwaterhomes.com/listings/images/pic/ujkvxk.html internet security site web] [http://2001.c3.hu/mas/htagkx.html pacific specialty ins] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/uumdpc.html fly ringtone] [http://aura.c3.hu/thumb/lnjfjf.html advertisement car old] [http://kom-pas.de/3xcms/config/hkatuploads/images/qrnspl.html rise service sun] [http://troniny.ovh.org/gallery/layout/qumcac.html spanish fort alabama] [http://kristinlyseggen.com/gallery/1documentaries/7travel/akuebm.html australia discount tours] [http://www.housing.und.edu/reshalls/blog/wp-content/uploads/2007/04/img/jovnlg.html codeine online] [http://2001.c3.hu/mas/xtrmbm.html watch a movie on line] [http://aura.c3.hu/thumb/ouvwqh.html library skills online] [http://aura.c3.hu/thumb/ddidki.html japanese constitution article 9]
{{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