Template:Metrics/Speed/doc

From Team Fortress Wiki
< Template:Metrics/Speed
Revision as of 22:33, 17 August 2012 by Org (talk | contribs) (Demo dox)
Jump to: navigation, search

This template drops in a class's speed, modified by settings that determine what the class has equipped (where appropriate). The C argument is the only one required. The A argument indicates the action the player is taking, and other arguments and values depend on the class. The W argument, if defined, means the value returned is modified by being under the Disciplinary Action effect.

Template defaults to 0 if the C argument is unknown, to avoid causing downstream parsing failures if used in an equation.

Arguments

Argument Meaning
C Class name
A Action
W If under Disciplinary Action effect
P Primary weapon
S Secondary weapon
M Melee weapon
G Item set (G stands for Group, synonym of set)
B Boost amount (Scout)
U ÜberCharge amount (Medic)
H Health (Soldier)
Heads taken (Demoman)
T Triggered ability (Heavy, Engineer, and Sniper)
Healing target's speed (Medic)
D Disguise (Spy)

Valid argument settings

C A W P S M G B U H T D
scout

One of

  • omitted
  • back
  • crouch
  • swim
Defined for
effect active
baby face's blaster crit-a-cola Positive real
0-99 inclusive
soldier cow mangler 5000 escape plan Positive integer
0-200 inclusive
pyro gas jockey's gear
demoman shield haunted
scotsman's skullcutter
Positive integer
0-4; inclusive
heavy brass beast buffalo steak sandvich gloves of running urgently deploy
engineer haul
medic overdose quick-fix Positive real
0-100 inclusive
Positive integer
0-520; inclusive
sniper huntsman cozy camper aim
spy Class name

† use to indicate the Chargin' Targe or the Splendid Screen
‡ use to indicate the Eyelander, the Horseless Headless Horsemann's Headtaker, or Nessie's Nine Iron


Sub-templates The speed values for each class are stored in sub-templates, due to overall complexity.