tf_gamerules

From Valve Developer Community
Jump to navigation Jump to search

Team Fortress 2 tf_gamerules is a point entity available in Team Fortress 2 Team Fortress 2. Proxy entity for TF Gamerules.

Icon-Important.pngImportant:This is a preserved entity in Team Fortress 2.
  • On a new round entities with this classname will intentionally not reset. You can use logic_auto to emulate resetting it.
  • Killing it removes it forever, as it is not respawned on a new round.
  • It cannot be spawned with a point_template.
  • Parenting this with non preserved entities may have undesirable effects.

Keyvalues

Name (targetname) <string>
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

Hud Type (hud_type) <choices>
Override the HUD type clients should display.
  • 0 : Default
  • 1 : CTF HUD
  • 2 : CP HUD
  • 3 : Payload HUD
CTF Overtime (ctf_overtime) <boolean>
Allow Overtime for CTF maps.
Holiday Ropes (ropes_holiday_lights_allowed) <boolean>
Allow ropes with holiday lights during the holiday event.

Inputs

SetRedTeamRespawnWaveTime <float>
Set the RED team's respawn wave time
SetBlueTeamRespawnWaveTime <float>
Set the BLU team's respawn wave time
AddRedTeamRespawnWaveTime <float>
Add to the RED team's respawn wave time
AddBlueTeamRespawnWaveTime <float>
Add to the BLU team's respawn wave time
SetRedTeamGoalString <string>
Set the RED team's goal string to show in the hud
Note.pngNote:Frequent compiling and testing will cause the map view log to automatically hide this message, and give the false impression it is not working. You can reset the logged map views by editing /media/viewed.res
SetBlueTeamGoalString <string>
Set the BLU team's goal string to show in the hud
Note.pngNote:Frequent compiling and testing will cause the map view log to automatically hide this message, and give the false impression it is not working. You can reset the logged map views by editing /media/viewed.res
SetRedTeamRole <integer>
Set RED team role, 0=none, 1=defenders, 2=attackers
SetBlueTeamRole <integer>
Set BLU team role, 0=none, 1=defenders, 2=attackers
SetRequiredObserverTarget <string>
Sets the given entity (by name) to be the required observer target for all spectators. Must be cleared to allow spectators to cycle through targets normally again.
Icon-Bug.pngBug:This does not properly block players trying to move the view, the view is just reset within a few ms.  [todo tested in?]
AddRedTeamScore <integer>
Add to the RED team score (can be a negative number)
AddBlueTeamScore <integer>
Add to the BLU team score (can be a negative number)
SetStalemateOnTimelimit <boolean>
Determines whether mp_timelimit can end the match in the middle of a round.
SetMapForcedTruceDuringBossFight <boolean>
ability for community Halloween maps to call a truce during a Monoculus or Merasmus fight.
SetRedKothClockActive
Set the RED team clock active for KOTH maps.
SetBlueKothClockActive
Set the BLU team clock active for KOTH maps.
SetCTFCaptureBonusTime <integer>
Set the length of crit bonus time (in seconds) for CTF captures.
HandleMapEvent
SetCustomUpgradesFile <string>
Sets the file path to a custom upgrades file. Relative to the game folder. (E.g. scripts/items/mvm_upgrades_custom.txt)
PlayVO <string>
Play a Soundscript to all players. Also accepts raw file paths.
PlayVOBlue <string>
Play a Soundscript to players on Blue team
PlayVORed <string>
Play a Soundscript to players on Red team

Outputs

OnTruceStart
Fired when Truce mode begins.
OnTruceEnd
Fired when Truce mode is over.
OnWonByTeam1
Sent when RED wins the round.
OnWonByTeam2
Sent when BLU wins the round.
Team1PlayersChanged <integer>
Sent when RED team player count changes, due to a player joining or leaving the team.
Team2PlayersChanged <integer>
Sent when BLUE team player count changes, due to a player joining or leaving the team.