Tf logic player destruction: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (used templates for targetnames)
(-added class hierarchy, cleanup)
 
(21 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{tf2 point|tf_logic_player_destruction}}
{{LanguageBar}}
{{CD|CTFPlayerDestructionLogic|nolink=1|file1=tf_logic_player_destruction.cpp}}
{{this is a|point entity|name=tf_logic_player_destruction|game=Team Fortress 2}}  
It is the master control entity for the [[Team Fortress 2/Player Destruction|Player Destruction]] gamemode.


== Entity description ==
== Keyvalues ==
The master control entity for the player destruction game mode.
 
==Keyvalues==
{{KV Targetname}}
{{KV Targetname}}
{{KV|Prop Model Name|studio|Model of prop that drops from player on death}}
{{KV|Prop Model Name|intn=prop_model_name|studio|Model of prop that drops from player on death}}
{{KV|Prop Drop Sound|sound|Sound when player drops prop}}
{{KV|Prop Drop Sound|intn=prop_drop_sound|sound|Sound when player drops prop}}
{{KV|Prop Pickup Sound|sound|Sound when player picks up prop}}
{{KV|Prop Pickup Sound|intn=prop_pickup_sound|sound|Sound when player picks up prop}}
{{KV|Blue Respawn Time|float|The base respawn time for BLU team}}
{{KV|Blue Respawn Time|intn=blue_respawn_time|float|The base respawn time for BLU team}}
{{KV|Red Respawn Time|float|The base respawn time for RED team}}
{{KV|Red Respawn Time|intn=red_respawn_time|float|The base respawn time for RED team}}
{{KV|Min Points|integer|The minimum points to win}}
{{KV|Min Points|intn=min_points|integer|The minimum points to win}}
{{KV|Points Per Player|integer|How many points to increase the max points by per player}}
{{KV|Points Per Player|intn=points_per_player|integer|How many points to increase the max points by per player}}
{{KV|Finale Length|float|The amount of time from after max score is reached a team will win}}
{{KV|Finale Length|intn=finale_length|float|The amount of time from after max score is reached a team will win}}
{{KV|HUD Res File|string|What res file to use for the HUD}}
{{KV|HUD Res File|intn=res_file|string|What res file to use for the HUD}}
{{KV|Flag Reset Delay (in seconds)|integer|Length of time (in seconds) before a dropped flag resets}}
{{KV|Flag Reset Delay (in seconds)|intn=flag_reset_delay|integer|Length of time (in seconds) before a dropped flag resets}}
{{KV|Heal Distance|integer|The distance for the team leader's ability to heal teammates}}
{{KV|Heal Distance|intn=heal_distance|integer|The distance for the team leader's ability to heal teammates}}


== Inputs ==
{{I|ScoreRedPoints|Score points for red.}}
{{I|ScoreBluePoints|Score points for blue.}}
{{I|EnableMaxScoreUpdating|Allow the max score to update based on player count.}}
{{I|DisableMaxScoreUpdating|Disallow the max score from updating based on player count.}}
{{I|SetCountdownTimer|param=integer|Set the countdown time and start the timer.}}
{{I|SetCountdownImage|param=string|Set the countdown image.}}
{{I|SetFlagResetDelay|param=integer|Set the length of time (in seconds) before a dropped flag resets.}}
{{I|SetPointsOnPlayerDeath|param=integer|Set number of points per flag dropped upon player death.}}


==Inputs==
==Outputs==
{{I Targetname}}
{{O|OnBlueHitMaxPoints|Sent when Blue hits the max points.}}
{{IO|ScoreRedPoints|Score points for red.}}
{{O|OnRedHitMaxPoints|Sent when Red hits the max points.}}
{{IO|ScoreBluePoints|Score points for blue.}}
{{O|OnBlueLeaveMaxPoints|Sent when blue goes from max points to fewer.}}
{{IO|EnableMaxScoreUpdating|Allow the max score to update based on player count.}}
{{O|OnRedLeaveMaxPoints|Sent when red goes from max points to fewer.}}
{{IO|DisableMaxScoreUpdating|Disallow the max score to update based on player count.}}
{{O|OnBlueHitZeroPoints|Sent when Blue hits 0 points.}}
{{KV|SetCountdownTimer|integer|Set the countdown time and start the timer.}}
{{O|OnRedHitZeroPoints|Sent when Red hits 0 points}}
{{KV|SetCountdownImage|string|Set the countdown image.}}
{{O|OnBlueHasPoints|Sent when Blue goes from 0 to any points}}
{{KV|SetFlagResetDelay|integer|Set the length of time (in seconds) before a dropped flag resets.}}
{{O|OnRedHasPoints|Sent when Red goes from 0 to any points}}
{{O|OnRedFinalePeriodEnd|Sent when the red finale period ends.}}
{{O|OnBlueFinalePeriodEnd|Sent when the blue finale period ends.}}
{{O|OnRedFirstFlagStolen|Sent when red's first flag gets stolen.}}
{{O|OnRedFlagStolen|Sent when a flag gets stolen from red.}}
{{O|OnRedLastFlagReturned|Sent when red's last stolen flag gets returned.}}
{{O|OnBlueFirstFlagStolen|Sent when blue's first flag gets stolen.}}
{{O|OnBlueFlagStolen|Sent when a flag gets stolen from blue.}}
{{O|OnBlueLastFlagReturned|Sent when blue's last stolen flag gets returned.}}
{{O|OnRedScoreChanged|param=float|Sent when score changes. Is a value representing total progress from 0–1.}}
{{O|OnBlueScoreChanged|param=float|Sent when score changes. Is a value representing total progress from 0–1.}}
{{O|OnCountdownTimerExpired|Sent when the countdown timer expires.}}


== See also ==
* [[Team Fortress 2/Player Destruction|Player Destruction Guide]]


==Outputs==
== External links ==
{{O Targetname}}
* [https://tf2maps.net/posts/344922/ Player Destruction Guide - TF2Maps.net]
{{IO|OnBlueHitMaxPoints|Sent when Blue hits the max points.}}
{{IO|OnRedHitMaxPoints|Sent when Red hits the max points.}}
{{IO|OnBlueLeaveMaxPoints|Sent when blue goes from max points to fewer.}}
{{IO|OnRedLeaveMaxPoints|Sent when red goes from max points to fewer.}}
{{IO|OnBlueHitZeroPoints|Sent when Blue hits 0 points.}}
{{IO|OnRedHitZeroPoints|Sent when Red hits 0 points}}
{{IO|OnBlueHasPoints|Sent when Blue goes from 0 to any points}}
{{IO|OnRedHasPoints|Sent when Red goes from 0 to any points}}
{{IO|OnRedFinalePeriodEnd|Sent when the red finale period ends.}}
{{IO|OnBlueFinalePeriodEnd|Sent when the blue finale period ends.}}
{{IO|OnRedFirstFlagStolen|Sent when red's first flag gets stolen.}}
{{IO|OnRedFlagStolen|Sent when a flag gets stolen from red.}}
{{IO|OnRedLastFlagReturned|Sent when red's last stolen flag gets returned.}}
{{IO|OnBlueFirstFlagStolen|Sent when blue's first flag gets stolen.}}
{{IO|OnBlueFlagStolen|Sent when a flag gets stolen from blue.}}
{{IO|OnBlueLastFlagReturned|Sent when blue's last stolen flag gets returned.}}
{{KV|OnRedScoreChanged|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.}}

Latest revision as of 16:29, 25 September 2024

English (en)Translate (Translate)
C++ Class hierarchy
CTFPlayerDestructionLogic
↳CTFRobotDestructionLogic
↳CBaseEntity
C++ tf_logic_player_destruction.cpp

tf_logic_player_destruction is a point entity available in Team Fortress 2 Team Fortress 2. It is the master control entity for the Player Destruction gamemode.

Keyvalues

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

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

Inputs

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 from updating based on player count.
SetCountdownTimer <integerRedirectInput/integer>
Set the countdown time and start the timer.
SetCountdownImage <stringRedirectInput/string>
Set the countdown image.
SetFlagResetDelay <integerRedirectInput/integer>
Set the length of time (in seconds) before a dropped flag resets.
SetPointsOnPlayerDeath <integerRedirectInput/integer>
Set number of points per flag dropped upon player death.

Outputs

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 <floatRedirectOutput/float>
Sent when score changes. Is a value representing total progress from 0–1.
OnBlueScoreChanged <floatRedirectOutput/float>
Sent when score changes. Is a value representing total progress from 0–1.
OnCountdownTimerExpired
Sent when the countdown timer expires.

See also

External links

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