func_portal_detector

 func_portal_detector is a brush entity available in the Portal series. It defines a region that fires an output if a portal is placed in it. Warning: This entity may misbehave when it or the surfaces intersecting it are moving.

Keyvalues

Portal pair ID that it detects <integer>

Portals are processed in numbered pairs. Check Starting Team on your weapon_portalgun for the correct number.

Check all portals <boolean> (New with Portal 2)

Ignore the Group ID and check for all portals.

Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Entity Scripts (vscripts) <scriptlist> (in all games since )

Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.

Script think function (thinkfunction) <string> (in all games since )

Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.

Note:Try to avoid expensive operations in this function, as it may cause performance problems.

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.

Targetname:

Kill

Removes this entity from the world.

KillHierarchy

Removes this entity and its children from the world.

Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.

AddOutput <string>

Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>

FireUser1 to FireUser4

Fire the OnUser outputs; see User Inputs and Outputs.

Use  !FGD

Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.

RunScriptFile <script> (in all games since )

Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.

RunScriptCode <string> (in all games since )

Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.

Bug: In , the code is executed in the script scope of the entity that fires the output, not the one receiving the input.

Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.

CallScriptFunction <string> (in all games since ) !FGD

Execute a VScript function in the scope of the receiving entity.

SetLocalOrigin <coordinates> (in all games since ) !FGD

Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.

SetLocalAngles <angles> (in all games since ) !FGD

Set this entity's angles.

Parentname:

SetParent <string>

Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <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 <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  (New with 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  (New with Portal 2)

Fired when a portal moves away from the entity.

OnEndTouchPortal1  (New with Portal 2)

Fired when portal 1 (blue) moves away from the entity.

OnEndTouchPortal2  (New with Portal 2)

Fired when portal 2 (orange) moves away from the entity.

OnEndTouchLinkedPortal  (New with Portal 2)

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 fire.

OnEndTouchBothLinkedPortals  (New with Portal 2)

Fired when both portals of a pair first touch the entity (OnStartTouchBothLinkedPortals), and then are moved away from it.

Note:If the player walks through a portal cleanser (thus removing portals) this output does not fire.

Targetname:

OnUser1 to OnUser4

These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.

OnKilled  (only in )

This output fires when the entity is killed and removed from the game.