Difference between revisions of "Template:Metrics/Speed/doc"

From Team Fortress Wiki
Jump to: navigation, search
(Documentation for Metrics/Speed)
 
(Removal of Crit-a-Cola speed bonus)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
This template drops in a classes speed, modified by settings that determine what the class has equipped (where appropriate).  The <code>C</code> argument is the only one required, and other arguments and values depend on the class. The <code>W</code> argument, if defined, means the value returned is modified by the [[Disciplinary Action]] Defaults to generating <code>0</code> if the <code>C</code> argument is unknown, to avoid causing downstream parsing failures if used in a equation.
+
This template drops in a class's speed, modified by settings that determine what the class has equipped (where appropriate).  The <code>C</code> argument is the only one required ([[Conga|unless dancing]]). The <code>A</code> argument indicates the action the player is taking, and other arguments and values depend on the class. The <code>W</code> argument, if defined, means the value returned is modified by being under the [[Disciplinary Action]] effect.
 +
 
 +
Template defaults to <code>0</code> if the <code>C</code> argument is unknown, to avoid causing downstream parsing failures if used in an equation.
  
 
'''Arguments'''
 
'''Arguments'''
Line 9: Line 11:
 
| C || Class name
 
| C || Class name
 
|-
 
|-
−
| W || ''If under [[Disciplinary Action]] effect''
+
| A || Action
 +
|-
 +
| W || ''If under one of the following effects''
 +
* [[Disciplinary Action]] buff
 +
* [[Concheror]] buff
 +
* [[Heavy]] after hitting with the [[Eviction Notice]]
 +
* [[Spy]] after killing with the [[Big Earner]]
 +
* [[Spy]] after feign death the [[Dead Ringer]]
 
|-
 
|-
 
| P || Primary weapon
 
| P || Primary weapon
Line 17: Line 26:
 
| M || Melee weapon
 
| M || Melee weapon
 
|-
 
|-
−
| G || Item set (G stands for Group, synonym of set)
+
| B || Boost amount ([[Scout]])
 
|-
 
|-
−
| B || Boost amount ([[Scout]])
+
| U || [[ÜberCharge]] amount ([[Medic]])
 
|-
 
|-
 
| H || Health ([[Soldier]])<br>Heads taken ([[Demoman]])
 
| H || Health ([[Soldier]])<br>Heads taken ([[Demoman]])
 +
|-
 +
| T || Triggered ability ([[Heavy]], [[Engineer]], and [[Sniper]])<br>Healing target's speed ([[Medic]])
 +
|-
 +
| D || Disguise ([[Spy]])
 
|}
 
|}
  
Line 28: Line 41:
 
|-
 
|-
 
! class = "header" | C
 
! class = "header" | C
 +
! class = "header" | A
 +
! class = "header" | W
 
! class = "header" | P
 
! class = "header" | P
 
! class = "header" | S
 
! class = "header" | S
 
! class = "header" | M
 
! class = "header" | M
−
! class = "header" | G
 
 
! class = "header" | B
 
! class = "header" | B
 +
! class = "header" | U
 
! class = "header" | H
 
! class = "header" | H
 +
! class = "header" | T
 +
! class = "header" | D
 
|-
 
|-
−
| scout || baby face's blaster || crit-a-cola || || || ''Positive real'' ||
+
| scout  
 +
| rowspan="9" |
 +
''One of''
 +
*''omitted''
 +
*back
 +
*crouch
 +
*swim
 +
| rowspan="9" | ''Defined for''<br>''effect active''
 +
            |baby face's blaster|||||||''Positive real''<br>0-100 inclusive||||||||
 
|-
 
|-
−
| soldier || colspan="6" | ''Not Yet Implemented''
+
| soldier ||cow mangler 5000||||escape plan|||||||''Positive integer''<br>0-200 inclusive||||
 
|-
 
|-
−
| pyro || colspan="6" | ''Not Yet Implemented''
+
| pyro     |||||||powerjack||||||||||
 
|-
 
|-
−
| demoman || colspan="6" | ''Not Yet Implemented''
+
| demoman ||''boots'' <small>*</small>||''shield'' <small>&dagger;</small>||''haunted'' <small>&Dagger;</small><br>scotsman's skullcutter|||||||''Positive integer''<br>0-4 inclusive||||
 
|-
 
|-
−
| heavy || colspan="6" | ''Not Yet Implemented''
+
| heavy   ||brass beast||buffalo steak sandvich||gloves of running urgently<br>eviction notice|||||||||deploy||
 
|-
 
|-
−
| engineer || colspan="6" | ''Not Yet Implemented''
+
| engineer |||||||||||||||haul||
 
|-
 
|-
−
| medic || colspan="6" | ''Not Yet Implemented''
+
| medic   ||overdose||quick-fix|||||||''Positive real''<br>0-100 inclusive||||''Positive integer''<br>0-520 inclusive||
 
|-
 
|-
−
| sniper || colspan="6" | ''Not Yet Implemented''
+
| sniper   ||huntsman|||||||||||||aim||
 
|-
 
|-
−
| spy || colspan="6" | ''Not Yet Implemented''
+
| spy     |||||||||||||||||''Class name''
 
|}
 
|}
 +
<small>*; use to indicate [[Ali Baba's Wee Booties]] or the [[Bootlegger]]<br>
 +
&dagger; use to indicate the [[Chargin' Targe]], [[Splendid Screen]], or the [[Tide Turner]]<br>
 +
&Dagger; use to indicate the [[Eyelander]], the [[Horseless Headless Horsemann's Headtaker]], or [[Nessie's Nine Iron]]</small>
 +
  
 
'''Sub-templates'''
 
'''Sub-templates'''

Latest revision as of 22:52, 20 October 2017

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 (unless dancing). 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 one of the following effects
P Primary weapon
S Secondary weapon
M Melee weapon
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 B U H T D
scout

One of

  • omitted
  • back
  • crouch
  • swim
 Defined for
effect active 		baby face's blaster Positive real
0-100 inclusive
soldier cow mangler 5000 escape plan Positive integer
0-200 inclusive
pyro powerjack
demoman boots * shield † haunted ‡
scotsman's skullcutter		 Positive integer
0-4 inclusive
heavy brass beast buffalo steak sandvich gloves of running urgently
eviction notice		 deploy
engineer haul
medic overdose quick-fix Positive real
0-100 inclusive		 Positive integer
0-520 inclusive
sniper huntsman aim
spy Class name

*; use to indicate Ali Baba's Wee Booties or the Bootlegger
† use to indicate the Chargin' Targe, Splendid Screen, or the Tide Turner
‡ 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.

Retrieved from "https://wiki.teamfortress.com/w/index.php?title=Template:Metrics/Speed/doc&oldid=2283511"