trigger_finale_dlc3

From Valve Developer Community
Revision as of 00:53, 2 August 2011 by Barracuda (talk | contribs) (Created page with "{{l4d point|trigger_finale_dlc3}} It is a controller for the special DLC3 finale. == Keyvalues == {{KV|World model|studio}} {{KV|Disable Shadows|boolean|Used to disable dynamic ...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

<Left 4 Dead> trigger_finale_dlc3 is a point entity available in Left 4 Dead. It is a controller for the special DLC3 finale.

Keyvalues

World model <model path>
Disable Shadows <boolean>
Used to disable dynamic shadows on this entity.

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.

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.

EnableDisable:

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (probably with the Enable input).

Inputs

FinaleEscapeFinished
Give the survivors a victory.
FinaleEscapeForceSurvivorPositions
Make the survivors stand still on the escape vehicle.
FinaleEscapeVehicleReadyForSurvivors
Make survivors say something about how the vehicle has stopped now.
ForceFinaleStart
Start the finale now.
EnableEscapeSequence
Allow the escape sequence to happen at the proper phase of the finale.
DisableEscapeSequence
Block the escape sequence from happening (until re-enabled). Infected will still spawn.
AdvanceFinaleState
Advances through the DLC3 Finale states
DLC3FinaleWon
Indicates the survivors have met the specific win conditions for the DLC3 finale.
DLC3FinaleLost
Indicates the survivors have failed the specific conditions for the DLC3 finale.
DLC3FinaleEnableChaseTanks
Turns on the chase tanks for the escape sequence
DLC3SacrificePlayerBeginsRun
A player has committed to the sacrifice run. (activator is the player)

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.

EnableDisable:

Enable
Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

FinaleEscapeStarted
Fired when the survivors should start their escape.
FinaleStart
Fired when the finale starts.
FinalePause
Fired during the pause between each finale wave.
EscapeVehicleLeaving
Fired when the escape vehicle starts to leave.
OnDLC3FinaleLull
Fired when there is a break while waiting for the next generator to be started

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.