prop_rocket_tripwire

From Valve Developer Community
Jump to: navigation, search
In-game screenshot of a prop_rocket_tripwire.


[Portal 2] prop_rocket_tripwire is a point entity available in Portal 2.

Entity description

Rocket tripwire. An unfinished entity from the development stage of Portal 2.

It fires rockets in a straight line to the direction it is looking when the player, an NPC or a physical prop is visible. It uses sounds (partially missing) and a simpler version of the model of Portal's npc_rocket_turret, but is much more static and doesn't use any of its animations.

FGD Code

@PointClass base(Targetname, Parentname, Angles) studio("models/props/tripwire_turret.mdl") = prop_rocket_tripwire :
"Rocket tripwire"
[
	RocketSpeed(float) : "Rocket speed" : "400.00" : "Speed of fired rockets in units/s."
	RocketLifetime(float) : "Rocket lifetime" : "15.00" : "Maximum flying time of a rocket in seconds."

	input  EnableTripwire(void) : "Enable tripwire."
	input  DisableTripwire(void) : "Disable tripwire."
	input  ForceFire(void) : "Trip the tripwire."
	
	output OnTripped(void) : "Fired whenever the tripwire is tripped."
	output OnRocketExplode(void) : "Fired whenever the tripwire rocket explodes."
]

Keyvalues

Rocket speed <float>
Speed of fired rockets in units/s.
Rocket lifetime <float>
Maximum flying time of a rocket in seconds.

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with 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 <string> (New with 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: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.

Angles:

Pitch Yaw Roll (Y Z X) <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.

Inputs

Targetname:

Kill
Removes this entity and any entities parented to it from the world.
KillHierarchy
Functions the same as Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster than Kill.
AddOutput  <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
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. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile  <script> (New with 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> (New with 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> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin  <coordinates> (New with 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> (New with Alien Swarm) !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

OnTripped
Fired whenever the tripwire is tripped.
OnRocketExplode
Fired whenever the tripwire rocket explodes.

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

External links