Difference between revisions of "Func liquidportal"

From Valve Developer Community
Jump to: navigation, search
m (Added 'R' to 'Remove' in last output)
Line 1: Line 1:
 
{{wrongtitle|title=func_liquidportal}}
 
{{wrongtitle|title=func_liquidportal}}
 
+
{{bug|This entity is incomplete and does not function.}}
 
== Entity description ==
 
== Entity description ==
 
Marks the space filled with portal liquid and teleport entities when done.
 
Marks the space filled with portal liquid and teleport entities when done.

Revision as of 19:24, 7 November 2010

Template:Wrongtitle

Bug: This entity is incomplete and does not function.

Entity description

Marks the space filled with portal liquid and teleport entities when done.

Availability

This brush-based entity is exclusive to Portal.

Keyvalues

  • Origin:

Origin (X Y Z) (origin) <origin>
The position of this entity's center in the world. Rotating entities typically rotate around their origin.

Angles:

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.
  • Linked liquid portal
<string>
  • Fill Time (sec)
<float> How long the volume takes to fill in seconds.

Inputs

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 <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: 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: 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.
  • SetLinkedLiquidPortal
The liquid portal this should link to. Will update linked portal to point back.
  • SetFillTime
How long the area takes to fill.
  • StartFilling
Start filling NOW. Entities teleport when finished.
  • AddActivatorToTeleportList
Add the activator entity to the list of entities to teleport when filling is finished.
  • RemoveActivatorFromTeleportList
Remove the activator entity from the list of entities to teleport when filling is finished.

Outputs

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