Difference between revisions of "Tf logic player destruction"

From Valve Developer Community
Jump to: navigation, search
(simplified kv names, added inputs / outputs)
m (kv tags for io that carry variables)
Line 22: Line 22:
 
{{IO|Kill|Removes this entity from the world.}}
 
{{IO|Kill|Removes this entity from the world.}}
 
{{IO|KillHiearchy|Removes this entity and all its children from the world.}}
 
{{IO|KillHiearchy|Removes this entity and all its children from the world.}}
{{IO|AddOutput|string|Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.}}
+
{{KV|AddOutput|string|Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.}}
 
{{IO|FireUser1|Causes this entity's OnUser1 output to be fired.}}
 
{{IO|FireUser1|Causes this entity's OnUser1 output to be fired.}}
 
{{IO|FireUser2|Causes this entity's OnUser2 output to be fired.}}
 
{{IO|FireUser2|Causes this entity's OnUser2 output to be fired.}}
Line 31: Line 31:
 
{{IO|EnableMaxScoreUpdating|Allow the max score to update based on player count.}}
 
{{IO|EnableMaxScoreUpdating|Allow the max score to update based on player count.}}
 
{{IO|DisableMaxScoreUpdating|Disallow the max score to update based on player count.}}
 
{{IO|DisableMaxScoreUpdating|Disallow the max score to update based on player count.}}
{{IO|SetCountdownTimer|integer|Set the countdown time and start the timer.}}
+
{{KV|SetCountdownTimer|integer|Set the countdown time and start the timer.}}
{{IO|SetCountdownImage|string|Set the countdown image.}}
+
{{KV|SetCountdownImage|string|Set the countdown image.}}
{{IO|SetFlagResetDelay|integer|Set the length of time (in seconds) before a dropped flag resets.}}
+
{{KV|SetFlagResetDelay|integer|Set the length of time (in seconds) before a dropped flag resets.}}
  
  
Line 57: Line 57:
 
{{IO|OnBlueFlagStolen|Sent when a flag gets stolen from blue.}}
 
{{IO|OnBlueFlagStolen|Sent when a flag gets stolen from blue.}}
 
{{IO|OnBlueLastFlagReturned|Sent when blue's last stolen flag gets returned.}}
 
{{IO|OnBlueLastFlagReturned|Sent when blue's last stolen flag gets returned.}}
{{IO|OnRedScoreChanged|float|Send when score changes, and is a value representing total progress from [0..1].}}
+
{{KV|OnRedScoreChanged|float|Send when score changes, and is a value representing total progress from [0..1].}}
{{IO|OnBlueScoreChanged|float|Send when score changes, and is a value representing total progress from [0..1].}}
+
{{KV|OnBlueScoreChanged|float|Send when score changes, and is a value representing total progress from [0..1].}}
 
{{IO|OnCountdownTimerExpired|Sent when the countdown timer expires.}}
 
{{IO|OnCountdownTimerExpired|Sent when the countdown timer expires.}}

Revision as of 18:15, 12 October 2015

<Team Fortress 2> tf_logic_player_destruction is a point entity available in Team Fortress 2.

Entity description

The master control entity for the player destruction game mode.

Keyvalues

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.
Prop Model Name <model path>
Model of prop that drops from player on death
Prop Drop Sound <sound>
Sound when player drops prop
Prop Pickup Sound <sound>
Sound when player picks up prop
Blue Respawn Time <float>
The base respawn time for BLU team
Red Respawn Time <float>
The base respawn time for RED team
Min Points <integer>
The minimum points to win
Points Per Player <integer>
How many points to increase the max points by per player
Finale Length <float>
The amount of time from after max score is reached a team will win
HUD Res File <string>
What res file to use for the HUD
Flag Reset Delay (in seconds) <integer>
Length of time (in seconds) before a dropped flag resets
Heal Distance <integer>
The distance for the team leader's ability to heal teammates


Inputs

Kill
Removes this entity from the world.
KillHiearchy
Removes this entity and all its children from the world.
AddOutput <string>
To do: add description
FireUser1
Causes this entity's OnUser1 output to be fired.
FireUser2
Causes this entity's OnUser2 output to be fired.
FireUser3
Causes this entity's OnUser3 output to be fired.
FireUser4
Causes this entity's OnUser4 output to be fired.
ScoreRedPoints
Score points for red.
ScoreBluePoints
Score points for blue.
EnableMaxScoreUpdating
Allow the max score to update based on player count.
DisableMaxScoreUpdating
Disallow the max score to update based on player count.
SetCountdownTimer <integer>
Set the countdown time and start the timer.
SetCountdownImage <string>
Set the countdown image.
SetFlagResetDelay <integer>
Set the length of time (in seconds) before a dropped flag resets.


Outputs

OnUser1
Fired in response to FireUser1 input.
OnUser2
Fired in response to FireUser2 input.
OnUser3
Fired in response to FireUser3 input.
OnUser4
Fired in response to FireUser4 input.
OnBlueHitMaxPoints
Sent when Blue hits the max points.
OnRedHitMaxPoints
Sent when Red hits the max points.
OnBlueLeaveMaxPoints
Sent when blue goes from max points to fewer.
OnRedLeaveMaxPoints
Sent when red goes from max points to fewer.
OnBlueHitZeroPoints
Sent when Blue hits 0 points.
OnRedHitZeroPoints
Sent when Red hits 0 points
OnBlueHasPoints
Sent when Blue goes from 0 to any points
OnRedHasPoints
Sent when Red goes from 0 to any points
OnRedFinalePeriodEnd
Sent when the red finale period ends.
OnBlueFinalePeriodEnd
Sent when the blue finale period ends.
OnRedFirstFlagStolen
Sent when red's first flag gets stolen.
OnRedFlagStolen
Sent when a flag gets stolen from red.
OnRedLastFlagReturned
Sent when red's last stolen flag gets returned.
OnBlueFirstFlagStolen
Sent when blue's first flag gets stolen.
OnBlueFlagStolen
Sent when a flag gets stolen from blue.
OnBlueLastFlagReturned
Sent when blue's last stolen flag gets returned.
OnRedScoreChanged <float>
Send when score changes, and is a value representing total progress from [0..1].
OnBlueScoreChanged <float>
Send when score changes, and is a value representing total progress from [0..1].
OnCountdownTimerExpired
Sent when the countdown timer expires.