Func portalled: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(→‎Outputs: fixed TODOs)
Line 23: Line 23:


==Outputs==
==Outputs==
{{IO|OnStartTouchPortal|since=P2}}
{{IO|OnStartTouchPortal|since=P2|Fired when a portal touches the entity.}}
{{IO|OnEndTouchPortal|since=P2}}
{{IO|OnStartTouchPortal1|Fired when portal 1 (blue) touches the entity.}}
{{IO|OnStartTouchPortal1|Fired when portal 1 (blue) is placed intersecting the portal detector.}}
{{IO|OnStartTouchPortal2|Fired when portal 2 (orange) touches the entity.}}
{{IO|OnStartTouchPortal2|Fired when portal 2 (orange) is placed intersecting the portal detector.}}
{{IO|OnStartTouchLinkedPortal|Fired when a linked portal touches the entity.}}
{{IO|OnStartTouchLinkedPortal|Fired when linked portal is placed intersecting the portal detector.}}
{{IO|OnStartTouchBothLinkedPortals|Fired when both portals of a pair touch the entity.}}
{{IO|OnStartTouchBothLinkedPortals|Fired when both of a pair of portals is placed intersecting the portal detector.}}
{{IO|OnEndTouchPortal|since=P2|Fired when a portal moves away from the entity.}}
{{IO|OnEndTouchPortal1|since=P2}}
{{IO|OnEndTouchPortal1|since=P2|Fired when portal 1 (blue) moves away from the entity.}}
{{IO|OnEndTouchPortal2|since=P2}}
{{IO|OnEndTouchPortal2|since=P2|Fired when portal 2 (orange) moves away from the entity.}}
{{IO|OnEndTouchLinkedPortal|since=P2|Fired when a linked portal intersecting the portal detector ceases to intersect the detector, or is no longer linked.}}
{{IO|OnEndTouchLinkedPortal|since=P2|Fired when a linked portal moves away from the entity, or is no longer linked.}}
{{Note|If the player walks through a portal cleanser (thus removing portals) this output does not. This is likely intentional; it prevents end of end of area cleansers from reactivating triggers where the player won't be returning to.}}
{{Note|If the player walks through a portal cleanser (thus removing portals) this output does not fire.}}
{{IO|OnEndTouchBothLinkedPortals|since=P2}}
{{IO|OnEndTouchBothLinkedPortals|since=P2|Fired when both portals of a pair first touch the entity (<code>OnStartTouchBothLinkedPortals</code>), and then are moved away from it.}}
{{IO|OnEntityPrePortalled|Fires when the entity is about to portal.}}
{{Note|If the player walks through a portal cleanser (thus removing portals) this output does not fire.}}
{{IO|OnEntityPostPortalled|Fires when the entity is done portalling.}}
{{IO|OnEntityPrePortalled|Fires a portal is crossed. Fires at the same time as <code>OnEntityPostPortalled</code> but this one is processed by the engine first. {{note|This will fire twice if both portals are touching the entity.}}}}
{{IO|OnEntityPostPortalled|Fires a portal is crossed. Fires at the same time as <code>OnEntityPrePortalled</code> but this one is processed by the engine last. {{note|This will fire twice if both portals are touching the entity.}}}}
{{O Targetname}}
{{O Targetname}}

Revision as of 02:26, 1 June 2018

Template:Portal2 brush

Entity description

It fires outputs when an entity teleports through a portal in its volume.

Keyvalues

Fire On Departure ([todo internal name (i)]) <boolean>
Fire when the entity is entering this portal
Fire On Arrival ([todo internal name (i)]) <boolean>
Fire when the entity is exiting this portal
Player ([todo internal name (i)]) <boolean>
Fire when a player has portalled
Portal pair ID that it detects ([todo internal name (i)]) <integer>
Check all portals ([todo internal name (i)]) <boolean> (in all games since Portal 2)
Ignore the Group ID and check for all portals.
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

Parentname:
Parent (parentname) <targetname>
Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma.

Flags

  • 1 : Start inactive

Inputs

EnableDisable:

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
Toggle:
Toggle
Toggle the enabled/disabled status of this entity.


Parentname:
SetParent <stringRedirectInput/string>
Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment <stringRedirectInput/string>
Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset <stringRedirectInput/string>
As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
ClearParent
Removes this entity from the the movement hierarchy, leaving it free to move independently.

Outputs

OnStartTouchPortal  (in all games since Portal 2)
Fired when a portal touches the entity.
OnStartTouchPortal1
Fired when portal 1 (blue) touches the entity.
OnStartTouchPortal2
Fired when portal 2 (orange) touches the entity.
OnStartTouchLinkedPortal
Fired when a linked portal touches the entity.
OnStartTouchBothLinkedPortals
Fired when both portals of a pair touch the entity.
OnEndTouchPortal  (in all games since Portal 2)
Fired when a portal moves away from the entity.
OnEndTouchPortal1  (in all games since Portal 2)
Fired when portal 1 (blue) moves away from the entity.
OnEndTouchPortal2  (in all games since Portal 2)
Fired when portal 2 (orange) moves away from the entity.
OnEndTouchLinkedPortal  (in all games since Portal 2)
Fired when a linked portal moves away from the entity, or is no longer linked.
Note.pngNote:If the player walks through a portal cleanser (thus removing portals) this output does not fire.
OnEndTouchBothLinkedPortals  (in all games since Portal 2)
Fired when both portals of a pair first touch the entity (OnStartTouchBothLinkedPortals), and then are moved away from it.
Note.pngNote:If the player walks through a portal cleanser (thus removing portals) this output does not fire.
OnEntityPrePortalled
Fires a portal is crossed. Fires at the same time as OnEntityPostPortalled but this one is processed by the engine first.
Note.pngNote:This will fire twice if both portals are touching the entity.
OnEntityPostPortalled
Fires a portal is crossed. Fires at the same time as OnEntityPrePortalled but this one is processed by the engine last.
Note.pngNote:This will fire twice if both portals are touching the entity.