From Valve Developer Community
Revision as of 16:02, 21 January 2012 by PluMGMK (talk | contribs) (Keyvalues)
Jump to: navigation, search

Portal Portal 2 prop_portal is a point entity available in the Portal series. It is a prop representing one of the two portals.

Warning.png Warning: Bad placement of a prop_portal will cause the location of the portal to revert to the map's origin.
Note.png Note: Portals will revert to the map's origin regardless of placement if set to start active.
Note.png Note: In order for a prop_portal to link up to the player's weapon_portalgun in Portal 2, the portal pair ID must be set to 1.

Placement Rules for Portal 2

  • 1-8 units from the surface the portal is to be placed on.
  • At least 57 units away from any adjacent surfaces on the top and bottom.
  • To do: Find minimum distance that adjacent surfaces can be on sides (probably slightly less than 32).


PortalTwo <boolean>
Is this portal an orange portal?
Activated <boolean>
Is this portal activated at start?
Bug.png Bug: In Portal 2, this will cause the portal to appear at the world origin.
LinkageGroupID <integer>
Portal pair ID that it belongs to.


Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (in all games since Left 4 Dead 2)
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 Left 4 Dead 2)
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.png Note: Try to avoid expensive operations in this function, as it may cause performance problems.


Pitch Yaw Roll (Y Z X) (angles) <angle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.


Naming your portals is fun
SetActivatedState <boolean>
Set Activated
Fizzle and remove
NewLocation <string>
Sets this portals location and angles. This expects 6 floats with space delimiters, the format is 'x y z pitch yaw roll'
Resize <string> (in all games since Portal 2)
Changes the size of the portals. Note that portals only function if they are the same size, and the coloured border remains the same size and proportions.


Removes this entity from the world.
Removes this entity and its children from the world.
Note.png 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 Left 4 Dead 2)
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 Left 4 Dead 2)
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.png Bug: In Left 4 Dead 2, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning.png 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 Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since Alien Swarm) !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 Alien Swarm) !FGD
Set this entity's angles.


Fired when portal spawns successfully


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 Left 4 Dead Left 4 Dead 2)
This output fires when the entity is killed and removed from the game.