commentary_dummy

From Valve Developer Community
Jump to: navigation, search

<Left 4 Dead><Left 4 Dead 2> commentary_dummy is a point entity available in the Left 4 Dead series. It is used in the Developer Commentary mode of both Left 4 Dead and Left 4 Dead 2 to display a model to the player, such as a Survivor model.

Keyvalues

Dummy Model <model path>
Eye Height <integer>
Eye height relative to origin. Only necessary when staring at players
Starting Animation <string>
The name of the starting animation that this dummy will play when it spawns.
Starting Weapons <string>
The names of any weapons the dummy should have when it spawns. Separated by spaces, commas, or semicolons. Last specified weapon will be equipped
Note:Requires weapon script names, such as "weapon_pistol" and "weapon_rifle_desert". Does not work with melee weapons. Only adds a weapon into the models hands, ignoring attachment points for carried items. Making listing multiple weapons useless, as only last listed weapon will be used
Stare at players <boolean>
Set to true if you want the dummy to attempt to stare at players all the time.
Note:If yet to "Yes" entire body turns towards player, but if set to "No", the models eyes will stare to the map center. Set "Head Yaw Pose Parameter" and "Head Pitch Pose Parameter" to a random letter to have the player not turn towards you and just have its eyes following you.
Head Yaw Pose Parameter <string>
The name of the head yaw pose parameter. Only necessary when staring at players
Head Pitch Pose Parameter <string>
The name of the head yaw pose parameter. Only necessary when staring at players

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.

Targetname:

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:Try to avoid expensive operations in this function, as it may cause performance problems.

Inputs

SetAnimation <string>
Force the dummy to play an animation. The parameter should be the name of the animation.

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.

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.