Trigger finale: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(rewrote introducion.)
Line 1: Line 1:
{{lang|Trigger finale}}
{{lang|Trigger finale}}
{{CD|CFinaleTrigger|CBreakableProp}}
{{CD|CFinaleTrigger|CBreakableProp}}
{{l4d series point|trigger_finale}} The entity [[trigger]]s the end of the current campaign session. Its location is crucial in determining the end of the escape route, also known as the flow of the single-map campaign or finale map in a multi-map campaign. If trigger_finale is not above the finale arena's nav mesh, the end of the escape route will be determined by the center of the all the nav areas marked with <code>FINALE</code>.
{{entity|type=e0|trigger_finale|series=Left 4 Dead}} It acts as trigger for the finale of a campaign and is capable of firing outputs for different stages of the finale.<br>
 
In most cases, if this entity is represented as a model in the world (like the ham-radio) it would be hidden until spawned by a {{ent|point_template}}, because first the players would interact with a {{ent|func_button}} tied to a {{ent|prop_dynamic}} to play an voice line and then spawn the actual trigger_finale. <br>
If trigger_finale is not above the finale arena's nav mesh, the end of the escape route will be determined by the center of the all the nav areas marked with <code>FINALE</code>.<br>
It has a duplicate entity with a different name, which is the<b><code>finale_trigger</code></b>entity.
It has a duplicate entity with a different name, which is the<b><code>finale_trigger</code></b>entity.


{{ModernNote|This entity is not required for survival gamemodes. Anything that fires the <code>ForcePanicEvent</code> on the {{ent|info_director}} will start survival finales.}}
== Keyvalues ==
== Keyvalues ==
{{KV|World model|intn=model|studio}}
{{KV|World model|intn=model|studio}}
Line 18: Line 20:
{{KV|Script File|intn=ScriptFile|string|since=l4d2|obsolete=1|Takes precedence over the standard <i><nowiki>[mapname]_finale.nut</nowiki></i> script by running in the <code>LocalScript</code> scope.}}
{{KV|Script File|intn=ScriptFile|string|since=l4d2|obsolete=1|Takes precedence over the standard <i><nowiki>[mapname]_finale.nut</nowiki></i> script by running in the <code>LocalScript</code> scope.}}
{{KV|Versus Travel|intn=VersusTravelCompletion|float|How much of the versus score is attained through travel to the finale (not valid in gauntlet finale).
{{KV|Versus Travel|intn=VersusTravelCompletion|float|How much of the versus score is attained through travel to the finale (not valid in gauntlet finale).
:{{Warning|Doesn't work with standard finale type.}}|since=L4D2}}
:{{ModernWarning|Doesn't work with standard finale type.}}|since=L4D2}}
{{KV|Is Sacrifice Finale|intn=IsSacrificeFinale|boolean|If true, one survivor has to be available to perform some action outside the escape vehicle.|since=L4D2}}
{{KV|Is Sacrifice Finale|intn=IsSacrificeFinale|boolean|If true, one survivor has to be available to perform some action outside the escape vehicle.|since=L4D2}}
{{KV Targetname}}
{{KV Targetname}}

Revision as of 07:22, 4 May 2023

English (en)中文 (zh)Translate (Translate)
C++ Class hierarchy
CFinaleTrigger
↳CBreakableProp
↳CBaseProp
↳CBaseAnimating
↳CBaseEntity

Template:Entity It acts as trigger for the finale of a campaign and is capable of firing outputs for different stages of the finale.
In most cases, if this entity is represented as a model in the world (like the ham-radio) it would be hidden until spawned by a point_template, because first the players would interact with a func_button tied to a prop_dynamic to play an voice line and then spawn the actual trigger_finale.
If trigger_finale is not above the finale arena's nav mesh, the end of the escape route will be determined by the center of the all the nav areas marked with FINALE.
It has a duplicate entity with a different name, which is thefinale_triggerentity.

Template:ModernNote

Keyvalues

World model (model) <model path>
Disable Shadows (disableshadows) <boolean>
Used to disable dynamic shadows on this entity.
First Use Delay (FirstUseDelay) <float>
For two-part finale starts, delays this many seconds before allowing another +use.
Use Delay (UseDelay) <float>
Starts the finale this many seconds after a +use.
Finale Type (type) <choices> (in all games since Left 4 Dead 2)
Specifies which style of finale to trigger:
  • 0 : Standard
  • 1 : Gauntlet
  • 2 : Custom
  • 3 : Broken. Starts the finale but stucks on PANIC stage and never spawns any infected at all. !FGD
  • 4 : Scavenge
Script File (ScriptFile) <string> (in all games since Left 4 Dead 2)
Takes precedence over the standard [mapname]_finale.nut script by running in the LocalScript scope.
Versus Travel (VersusTravelCompletion) <float> (in all games since Left 4 Dead 2)
How much of the versus score is attained through travel to the finale (not valid in gauntlet finale).
Template:ModernWarning
Is Sacrifice Finale (IsSacrificeFinale) <boolean> (in all games since Left 4 Dead 2)
If true, one survivor has to be available to perform some action outside the escape vehicle.
Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (with theEnableinput).

Inputs

FinaleEscapeFinished
Gives the survivors a victory, starts playing the credits music and consolidates the campaign stats.
FinaleEscapeForceSurvivorPositions
Teleports the survivors to a set of info_survivor_position entities. Used to make the survivors stand still on the escape vehicle or hide them. Required for the credits/stats to correctly count who escaped and who died in the finale.
FinaleEscapeVehicleReadyForSurvivors
Unlocks the escape vehicle navigation mesh areas, and makes survivors speak out that the vehicle has arrived.
ForceFinaleStart
Start the finale now. Only works when all survivors have entered the finale area marked in the navigation mesh.
EnableEscapeSequence  (only in Left 4 Dead)
Allow the escape sequence to happen at the proper phase of the finale.
DisableEscapeSequence  (only in Left 4 Dead)
Block the escape sequence from happening (until re-enabled). Infected will still spawn.
GauntletStopPanic  (in all games since Left 4 Dead 2)
Move the gauntlet finale state out of continuous panic mode. Advances to the tank stage the first time it is called, and the escape sequence the second time.
AdvanceFinaleState  (in all games since Left 4 Dead 2)
Increments the finale stage.
SacrificeEscapeFailed  (in all games since Left 4 Dead 2)
Indicates the survivors failed the escape requirements.
SacrificeEscapeSucceeded  (in all games since Left 4 Dead 2)
Indicates the survivors met the escape requirements.
SacrificePlayerBeginsRun  (in all games since Left 4 Dead 2)
A player has committed to the sacrifice run. (!activator is the player)
ForceTankSpawn  (in all games since Left 4 Dead 2)
Possibly only for Gauntlet style finale in-play.

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.
FinaleWon
Fired when the survivors win the finale.
FinaleLost
Fired when the survivors lose the finale.
FirstUseStart
Fired when a player uses the trigger the first time.
UseStart
Fired when a player uses the trigger to start the finale.
FinaleStart
Fired when the finale starts.
FinalePause
Fired during the pause between each finale wave.
EscapeVehicleLeaving
Fired when the escape vehicle starts to leave.

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Trigger_finale&oldid=303787"