Func areaportal: Difference between revisions
Jump to navigation
Jump to search
In code, it is represented by the
m (Adjustment in response to a change to Template:distinguish.) |
(-internal names better formatting, more concise page) |
||
Line 10: | Line 10: | ||
==Keyvalues== | ==Keyvalues== | ||
{{KV|Name of Linked Door | {{KV|Name of Linked Door|intn=target|targetname|A {{ent|prop_door_rotating}} or {{ent|func_door}} whose open/closed state controls the on/off state of the portal. This is optional.}} | ||
{{KV|Initial State | {{KV|Initial State|intn=StartOpen|bool|Initial state of the portal.}} | ||
{{KV | {{KV Targetname}} | ||
==Inputs== | ==Inputs== | ||
Line 18: | Line 18: | ||
{{IO|Close|Sets the portal to the closed state.}} | {{IO|Close|Sets the portal to the closed state.}} | ||
{{IO|Toggle|Opens the portal if closed. Closes the portal if open.}} | {{IO|Toggle|Opens the portal if closed. Closes the portal if open.}} | ||
==See Also== | ==See Also== |
Revision as of 12:24, 19 October 2022
Not to be confused with linked_portal_door (An unrelated entity, sometimes referred to as a "world portal").
Template:Base brush 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.

CAreaPortal
class, defined in thefunc_areaportal.cpp
file.
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.
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentname
ortarget
).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
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.