Difference between revisions of "Template:Backpack item/doc"

From Team Fortress Wiki
Jump to: navigation, search
(fixing)
Line 5: Line 5:
 
{| class="wikitable grid"
 
{| class="wikitable grid"
 
! width="15%" class="header" | Parameter
 
! width="15%" class="header" | Parameter
! width="25%" class="header" | Example
+
! width="35%" class="header" | Example
! width="25%" class="header" | Description
+
! class="header" | Description
! class="header" | Result
+
|- <!-- This section is for parameters which effect the item name. -->
|-
 
! style="text-align:left;" class="header" colspan="4" | ''Basics''
 
|-
 
 
| {{code|item-name}}
 
| {{code|item-name}}
| {{code|Condor Cap}}
+
| {{code|Batter's Helmet}}
| Proper item name in English (Condor Cap instead of Bonnet de condor). Automatically grabs the item's icon. The item name will be automatically translated on any language subpages.
+
| Proper item name in English (e.g. {{xt|Batter's Helmet}} instead of {{!xt|Casque de Batteur}}). The item name will be automatically translated on language subpages.
|
 
{{Backpack item
 
| item-name = Condor Cap
 
| item-kind = Hat
 
}}
 
 
|-
 
|-
 
| {{code|custom-name}}
 
| {{code|custom-name}}
 
| {{code|Spam Hammer}}
 
| {{code|Spam Hammer}}
| Adds a [[Name Tag|custom name]] with quotation marks. Still needs {{code|item-name}} to produce the correct image.
+
| Adds a custom name with quotation marks. Still needs {{code|item-name}} to produce the correct image.
|
 
{{Backpack item
 
| item-name = Homewrecker
 
| custom-name = Spam Hammer
 
| item-kind = Sledgehammer
 
| item-level = 5
 
| att-1-positive = +100% damage vs buildings
 
| att-2-positive = Damage removes Sappers
 
| att-3-negative = -25% damage vs players
 
}}
 
 
|-
 
|-
 
| {{code|no-custom-name-quotes}}
 
| {{code|no-custom-name-quotes}}
 
| {{code|yes}}
 
| {{code|yes}}
| Removes quotation marks from custom names if the {{code|custom-name}} field is used. Still needs {{code|item-name}} to produce the correct image.
+
| Removes quotation marks from custom names if the {{code|custom-name}} field is used.
|
 
{{Backpack item
 
| item-name = Texas Slim's Dome Shine
 
| custom-name = Smooth as Butter
 
| no-custom-name-quotes = yes
 
| item-kind = Hat
 
| item-description = Sometimes you just need a little less hat.
 
}}
 
 
|-
 
|-
 
| {{code|custom-icon}}
 
| {{code|custom-icon}}
| {{code|BLU Bombcart.png}}
+
| {{code|File:User Username my item icon.png}}
 
| Adds a custom icon for users' own purposes. This parameter is independent from {{code|item-name}} parameter.
 
| Adds a custom icon for users' own purposes. This parameter is independent from {{code|item-name}} parameter.
|
 
{{Backpack item
 
| item-name = Mr. Quackers
 
| custom-icon = BLU Bombcart.png
 
| item-kind = Mask
 
| grade = Assassin
 
}}
 
 
|-
 
|-
 
| {{code|quality}}
 
| {{code|quality}}
| {{code|genuine}}
+
| {{code|normal}}
 
| Defaults to "{{code|unique}}" (the standard item yellow). See [[Item quality]] for a list of accepted values.
 
| Defaults to "{{code|unique}}" (the standard item yellow). See [[Item quality]] for a list of accepted values.
|
 
{{Backpack item
 
| item-name = Horseless Headless Horsemann's Headtaker
 
| quality = genuine
 
| item-kind = Axe
 
| item-description = Cursed by dark spirits similar to those that dwell within the Eyelander.
 
| item-flags = Not Tradable or Marketable
 
| att-1-neutral = This weapon has a large melee range and deploys and holsters slower
 
| att-2-negative = No random critical hits
 
| att-3-negative = -25 max health on wearer
 
}}
 
 
|-
 
|-
 
| {{code|prefix}}
 
| {{code|prefix}}
| {{code|none}}<br>{{code|The Best}}
+
| {{code|none}}<br />{{code|The Best}}
| Set to "none" to hide any prefix added by {{code|quality}}, while keeping the quality's color. Can use a custom value.
+
| Set to "none" to hide the "Vintage" or "Community", etc, prefix but keeping the colour. Can also use a custom value, e.g. "{{code|1=prefix = The Best}}" will generate "The Best Flare Gun".
|
 
{{Backpack item
 
| item-name = Flare Gun
 
| prefix = The Best
 
| item-kind = Flare Gun
 
| item-level = 10
 
| item-description = This weapon will reload when not active
 
| att-1-positive = 100% critical hit vs burning players
 
}}
 
 
|-
 
|-
 
| {{code|suffix}}
 
| {{code|suffix}}
| {{code|none}}<br>{{code|(Slight Return)}}
+
| {{code|none}}<br />{{code|The Best}}
| Similar to {{code|prefix}}, mainly for use in non-en pages. Can use a custom value.
+
| Same as 'prefix' for non-en pages. Can also use a custom value, e.g. "{{code|1=suffix = The Best}}" will generate "Flare Gun The Best".
|
 
{{Backpack item
 
| item-name = Flame Thrower
 
| suffix = (Slight Return)
 
| quality = normal
 
| item-kind  = Flame Thrower
 
| item-level = 1
 
| att-1-positive = Extinguishing teammates restores 20 health
 
| item-description = Afterburn reduces Medi Gun healing and resist shield effects.<br>Alt-Fire: Release a blast of air that pushes enemies and projectiles and extinguish teammates that are on fire.
 
}}
 
 
|-
 
|-
 
| {{code|filter}}
 
| {{code|filter}}
 
| {{code|Coldfront}}
 
| {{code|Coldfront}}
| Adds the appropriate [[Strange Filter]] prefix/suffix to the weapon. See [[List of maps]] for a list of accepted values.
+
| Adds the appropriate [[Strange Filter]] prefix / suffix to the weapon.
|
 
{{Backpack item
 
| item-name = Shotgun
 
| filter = Coldfront
 
| strange-icon = yes
 
| rankson = kills
 
| killcount = 0
 
| quality = strange
 
| item-kind  = Shotgun
 
| item-level = 1
 
}}
 
 
|-
 
|-
 
| {{code|paint-color}}
 
| {{code|paint-color}}
 
| {{code|Mann Co. Orange}}
 
| {{code|Mann Co. Orange}}
| Adds a colored paint splat at the top right of the item icon, indicating the item is painted. See [[Paint Can]] for a list of accepted values.
+
| Adds the colored paint 'splat' specified to the top right of the item icon.
|
 
{{Backpack item
 
| item-name = Mislaid Sweater
 
| paint-color = Mann Co. Orange
 
| prefix = The
 
| item-kind = Sweater
 
| grade = commando
 
}}
 
 
|-
 
|-
 
| {{code|unusual-effect}}
 
| {{code|unusual-effect}}
| {{code|Stormy Storm}}
+
| {{code|Bubbling}}
| Adds the specified Unusual effect to the item's description. Also adds an Unusual at the top right of the item icon, indicating the item has an Unusual effect. See [[Unusual]] for a list of accepted values.
+
| Adds the Particle Effect icon to the top right of the item's icon. Also adds the "Unusual Effect:" line.
|
 
{{Backpack item
 
| item-name = Rimmed Raincatcher
 
| unusual-effect = Stormy Storm
 
| quality = unusual
 
| item-kind = Hat
 
| item-description = Because there's no alliteration like alliteration with an 'ARR!'
 
}}
 
 
|-
 
|-
 
| {{code|strange-icon}}
 
| {{code|strange-icon}}
 
| {{code|yes}}
 
| {{code|yes}}
| Adds an icon at the top right of the item icon, indicating the item is [[Strange]].
+
| Adds the Strange/StatTrack icon to the top right of the item's icon.
|
 
{{Backpack item
 
| item-name = Scattergun
 
| strange-icon = yes
 
| rankson = kills
 
| killcount = 0
 
| quality = strange
 
| item-kind  = Scattergun
 
}}
 
 
|-
 
|-
 
| {{code|decal-icon}}
 
| {{code|decal-icon}}
 
| {{code|yes}}
 
| {{code|yes}}
| Adds [[:File:Paint_Splat_Decal.png|this]] icon at the top right of the item icon, indicating the item has a [[Decal]] applied.
+
| Adds this [[:File:Paint_Splat_Decal.png|icon]] to the top right of the item's icon. Only used on the [[Items]] page.
|
 
{{Backpack item
 
| item-name = Photo Badge
 
| decal-icon = yes
 
| item-kind = Photo Badge
 
| item-level = 20
 
| item-description = Discourage identity theft.<br><br>Custom decals can be applied to this item.
 
}}
 
 
|-
 
|-
! style="text-align:left;" class="header" colspan="4" | ''Attributes''
+
! style="text-align:left;" class="header" colspan="3" | ''Attributes''
 
|- <!-- This section is for parameters which modify the item description. -->
 
|- <!-- This section is for parameters which modify the item description. -->
 
| {{code|item-level}}
 
| {{code|item-level}}
| {{code|68}}<br>| {{code|none}}
+
| {{code|50}}
| The item's level. Set to "none" to hide the level. Defaults to "<span class="att_level">Level 1 - 100</span>". Can use a custom value.
+
| Item level. Defaults to "<span class="att_level">1 - 100</span>".
|
 
{{Backpack item
 
| item-name = Antarctic Researcher
 
| prefix = The
 
| item-kind = Coat
 
| item-level = 68
 
}}
 
 
|-
 
|-
 
| {{code|item-kind}}
 
| {{code|item-kind}}
 
| {{code|Hat}}
 
| {{code|Hat}}
 
| Item kind. This string is not automatically translated.
 
| Item kind. This string is not automatically translated.
|
+
|-
{{Backpack item
+
| {{code|no-level}}
| item-name = Lucky Cat Hat
+
| {{code|yes}}
| grade = Elite
+
| Optional attribute. If "yes", item level will not be displayed.
| item-kind = Absolute Meower
 
}}
 
 
|-
 
|-
 
| {{code|limited}}
 
| {{code|limited}}
 
| {{code|yes}}
 
| {{code|yes}}
| If set to "yes", the the item kind will be colored yellow, and the word "Limited" will be added with a link to [[Limited Quantity]].
+
| Optional attribute. If "yes", the item name will be colored yellow, the word "Limited" will be added with a link to [[Limited Quantity]].
|
 
{{Backpack item
 
| item-name = Batter's Helmet
 
| limited = yes
 
| item-kind = Hat
 
| item-description = You'll be batting a thousand (skulls in) when you don this red piece of plastic!
 
}}
 
 
|-
 
|-
 
| {{code|grade}}
 
| {{code|grade}}
| {{code|Commando}}
+
| {{code|elite}}
| Colors the item's name according to the specified [[grade]], and treats it like a graded item. Valid options are <code>Civilian, Freelance, Mercenary, Commando, Assassin, Elite</code>.
+
| Optional attribute. If specified, the item name will be colored correctly for the grade, and the name of the grade will be added before the name, e.g.: Elite Grade Rocket Launcher. Valid options are <code>Civilian, Freelance, Mercenary, Commando, Assassin, Elite</code>
|
 
{{Backpack item
 
| item-name = Sapper
 
| grade = Commando
 
| quality = Normal
 
| item-kind = Sapper
 
| item-description = Place on enemy buildings to disable and slowly drain away its health. Placing a sapper does not remove your disguise
 
}}
 
 
|-
 
|-
 
| {{code|wear}}
 
| {{code|wear}}
| {{code|Field-Tested}}
+
| {{code|factory new}}
| For use on [[Decorated]] weapons. Valid options are <code>Battle Scarred, Well-Worn, Field-Tested, Minimal Wear, Factory New</code>.
+
| Optional attribute, for decorated weapons. Listed in parenthesis after the item name, e.g.: Rocket Launcher (Factory New). Valid options are <code>Battle Scarred, Well-Worn, Field-Tested, Minimal Wear, Factory New.</code>
|
 
{{Backpack item
 
| item-name = Minigun
 
| wear = Field-Tested
 
| skin = War Room
 
| grade = Commando
 
| item-kind = Minigun
 
}}
 
 
|-
 
|-
 
| {{code|skin}}
 
| {{code|skin}}
 
| {{code|Warhawk}}
 
| {{code|Warhawk}}
| Decorated skin name. See [[Template:Dictionary/decorated#Skins]] for a list of accepted values.
+
| Paintkit name. See [[Template:Dictionary/decorated#Skins]] for a list of accepted values.
|
 
{{Backpack item
 
| item-name = Rocket Launcher
 
| wear = Factory New
 
| skin = Warhawk
 
| grade = Elite
 
| item-kind = Rocket Launcher
 
}}
 
 
|-
 
|-
 
| {{code|rankson}}
 
| {{code|rankson}}
| {{code|Buildings Sapped}}
+
| {{code|Kills}}
| Primary stat being tracked for a Strange item.
+
| Primary stat method for a strange weapon.
|
 
{{Backpack item
 
| item-name = Shovel
 
| strange-icon = yes
 
| rankson = Buildings Sapped
 
| killcount = 0
 
| quality = strange
 
| item-kind  = Shovel
 
}}
 
 
|-
 
|-
 
| {{code|killcount}}
 
| {{code|killcount}}
| {{code|7613}}
+
| {{code|7616}}
| Number of points for the primary stat being tracked. Can use a custom value.
+
| Number of kills for the primary rank method.
|
 
{{Backpack item
 
| item-name = Big Elfin Deal
 
| strange-icon = yes
 
| rankson = Points Scored
 
| killcount = 7613
 
| quality = strange
 
| item-kind  = Hat
 
| item-description = You ask me if I wanna be a dentist one more time, pal, I'm gonna kick your teeth in.
 
}}
 
 
|-
 
|-
 
| {{code|rankson2}}
 
| {{code|rankson2}}
| {{code|Kill assists}}
+
| {{code|Kill assists}} or {{code|Damage dealt}}
| For [[Strange Part]]s or the secondary stat being tracked. {{code|rankson3}} and {{code|rankson4}} work similarly.
+
| Secondary rank method '''or''' strange part. {{code|rankson3}} and {{code|rankson4}} work similarly.
|
 
{{Backpack item
 
| item-name = Medi Gun
 
| strange-icon = yes
 
| rankson = Ubers
 
| rankson2 = Kill Assists
 
| killcount = 0
 
| killcount2 = 0
 
| quality = strange
 
| item-kind  = Medi Gun
 
}}
 
 
|-
 
|-
 
| {{code|killcount2}}
 
| {{code|killcount2}}
| {{code|50}}
+
| {{code|12}}
| Number of points for Strange Parts or the secondary stat being tracked. {{code|killcount3}} and {{code|killcount4}} work similarly. Can use a custom value.
+
| Number of kills for the secondary rank method '''or''' first strange part. {{code|killcount3}} and {{code|killcount4}} work similarly.
|
 
{{Backpack item
 
| item-name = Sniper Rifle
 
| strange-icon = yes
 
| rankson = Kills
 
| rankson2 = Damage Dealt
 
| killcount = 0
 
| killcount2 = 50
 
| quality = strange
 
| item-kind  = Sniper Rifle
 
}}
 
 
|-
 
|-
 
|   
 
|   
Line 295: Line 107:
 
<code>att-<sub>n</sub>-negative</code>
 
<code>att-<sub>n</sub>-negative</code>
 
|  
 
|  
<code>att-1-neutral = Cloak Type: Feign Death</code><br>
+
<code>att-1-neutral = Cloak Type: Feign Death</code><br />
<code>att-2-positive = Live forever!</code><br>
+
<code>att-2-positive = +80% cloak regen rate</code><br />
<code>att-3-negative = Just kidding.</code>
+
<code>att-3-negative = +60% cloak drain rate</code><br />
| Displays up to 8 positive, negative, or neutral values. Can use custom values.
+
(See section on [[#Examples|examples]] below)
|
+
| Displays up to 8 positive, negative and neutral values.
{{Backpack item
 
| item-name = Dead Ringer
 
| item-kind = Invis Watch
 
| item-level = 5
 
| att-1-neutral = Cloak Type: Feign Death
 
| att-2-positive = Live forever!
 
| att-3-negative = Just kidding.
 
}}
 
 
|-
 
|-
 
| {{code|item-description}}
 
| {{code|item-description}}
 
| {{code|It doesn't matter how much people respect you when they're on fire.}}
 
| {{code|It doesn't matter how much people respect you when they're on fire.}}
| For items that have an in-game description. This displays the description in a smaller font in order to distinguish from neutral attributes. Will not display if a {{code|custom-description}} is set. Can use a custom value.
+
| For items that have an in-game description. This displays the description in a smaller font in order to distinguish from neutral attributes. Will not display if a {{code|custom-description}} is set.
|
 
{{Backpack item
 
| item-name = Yule Hog
 
| item-kind = Hat
 
| grade = Mercenary
 
| item-description = It doesn't matter how much people respect you when they're on fire.
 
}}
 
 
|-
 
|-
 
| {{code|custom-description}}
 
| {{code|custom-description}}
 
| {{code|This hat is the greatest.}}
 
| {{code|This hat is the greatest.}}
| For items that have a custom in-game description (from a [[Description Tag]]). Displays like a normal description but has quotation marks surrounding it. Can use a custom value.
+
| For items that have a custom in-game description (from a [[Description Tag]]). Displays like a normal description but has quotation marks surrounding it.
|
 
{{Backpack item
 
| item-name = Napper's Respite
 
| item-kind = Hat
 
| custom-description = This hat is the greatest.
 
}}
 
 
|-
 
|-
 
| {{code|gift-from}}
 
| {{code|gift-from}}
 
| {{code|Robin}}
 
| {{code|Robin}}
| Display the source of a gifted item. Can use a custom value.
+
| Display the source of a gifted item. Displays the text "<span class="att_positive">Gift from: Robin</span>"
|
 
{{Backpack item
 
| item-name = Robin Walkers
 
| item-kind = Slippers
 
| grade = Elite
 
| gift-from = Robin
 
| date-received = Mar 29, 2018 (21:43:08)
 
}}
 
 
|-
 
|-
 
| {{code|date-received}}
 
| {{code|date-received}}
| {{code|Sep 13, 2188 (06:30:00)}}
+
| {{code|Mar 23, 2011 (06:30:00)}}
| Display the date a gifted item was received. Will not appear if no {{code|gift-from}} is defined. Can use a custom value.
+
| Display the date a gifted item was received. Will not appear if no {{code|gift-from}} is defined. Displays the text "<span class="att_neutral">Date Received: Mar 23, 2011 (06:30:00)</span>"
|
 
{{Backpack item
 
| item-name = Level Three Chin
 
| item-kind = Chin
 
| prefix = The
 
| item-level = 3
 
| gift-from = boba
 
| date-received = Sep 13, 2188 (06:30:00)
 
}}
 
 
|-
 
|-
 
| {{code|item-expiration}}
 
| {{code|item-expiration}}
 
| {{code|Dec 31, 2010 (23:00:00)}}
 
| {{code|Dec 31, 2010 (23:00:00)}}
| For items that expire. Can use a custom value.
+
| For items that expire. Displays the text "<span class="att_negative">This item will expire on Dec 31, 2010 (23:00:00).</span>".
|
+
|-
 +
| {{code|item-uses}}
 +
| {{code|5}}
 +
| For items that have "uses". Displays the text "<span class="att_uses">This is a limited item. Uses: 5</span>".
 +
|-
 +
| {{code|item-flags}}
 +
| {{code|Not Tradable or Usable in Crafting}}
 +
| For item flags. Displays them inside brackets: "<span class="att_flags">( Not Tradable or Usable in Crafting )</span>".
 +
|-
 +
! style="text-align:left;" class="header" colspan="3" | ''Styling''
 +
|-
 +
| {{code|width}}
 +
| {{code|25%}}
 +
| Width parameter. Defaults to {{code|100%}} in infoboxes, but for other usages, can be any value (%, px, pt, em).
 +
|-
 +
| {{code|style}}
 +
|
 +
| Style parameter. Can add any valid CSS style to the main div.
 +
|-
 +
|}
 +
 
 +
== Examples ==
 +
{| class="wikitable grid"
 +
! class="header" width="50%" | Code
 +
! class="header" width="50%" | Output
 +
|-
 +
|<pre>
 
{{Backpack item
 
{{Backpack item
| item-name = Gift-Stuffed Stocking
+
| item-name = Cloak and Dagger
| item-uses = 1
+
| item-level = 5
| item-level = 13
+
| item-kind = Invis Watch
| item-kind = Gift
+
| att-1-neutral = Cloak Type: Feign Death
| item-flags = Not Tradable or Marketable
+
| att-2-positive = +80% cloak regen rate
| item-description = Contains an assortment of goodies for good little Mercenaries.
+
| att-3-negative = +60% cloak drain rate
| item-expiration = Dec 31, 2010 (23:00:00)
+
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Cloak and Dagger
 +
| item-level = 5
 +
| item-kind = Invis Watch
 +
| att-1-neutral = Cloak Type: Feign Death
 +
| att-2-positive = +80% cloak regen rate
 +
| att-3-negative = +60% cloak drain rate
 
}}
 
}}
 
|-
 
|-
| {{code|item-uses}}
+
|<pre>
| {{code|4}}
 
| For items that have a limited number of uses. Can use a custom value.
 
|
 
 
{{Backpack item
 
{{Backpack item
| item-name = Noise Maker - Black Cat
+
| item-name = Rocket Launcher
| item-uses = 4
+
| custom-name = Rawket Lawnchair
| item-level = 5
+
| quality = vintage
| item-kind = Party Favor
+
| item-level = 50
 +
| item-kind = Furniture
 +
| att-1-positive = +20% additional comfort
 +
| att-2-positive = +35% increase in lumbar support
 +
| att-3-negative = +50% increase in financial hardship
 +
| custom-description = For those who favour comfort over fiscal stability.
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Rocket Launcher
 +
| custom-name = Rawket Lawnchair
 +
| quality = vintage
 +
| item-level = 50
 +
| item-kind = Furniture
 +
| att-1-positive = +20% additional comfort
 +
| att-2-positive = +35% increase in lumbar support
 +
| att-3-negative = +50% increase in financial hardship
 +
| custom-description = For those who favour comfort over fiscal stability.
 
}}
 
}}
 
|-
 
|-
| {{code|item-flags}}
+
|<pre>
| {{code|Not Tradable, Marketable, or Usable in Crafting}}
 
| For item flags. Displays them inside brackets. Can use a custom value.
 
|
 
 
{{Backpack item
 
{{Backpack item
 
| item-name = Wiki Cap
 
| item-name = Wiki Cap
Line 389: Line 208:
 
| item-kind = Hat
 
| item-kind = Hat
 
| item-level = 20
 
| item-level = 20
| unusual-effect   = Community Sparkle
+
| item-flags = Not Tradable or Usable in Crafting
| item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 wiki<br><nowiki>http://wiki.teamfortress.com/</nowiki>
+
| unusual-effect = Community Sparkle
| item-flags = Not Tradable, Marketable, or Usable in Crafting
+
| item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 Wiki<br><nowiki>http://wiki.teamfortress.com/</nowiki>
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Wiki Cap
 +
| quality = community
 +
| item-kind = Hat
 +
| item-level = 20
 +
| item-flags = Not Tradable or Usable in Crafting
 +
| unusual-effect = Community Sparkle
 +
| item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 Wiki<br><nowiki>http://wiki.teamfortress.com/</nowiki>
 
}}
 
}}
 
|-
 
|-
! style="text-align:left;" class="header" colspan="4" | ''Styling''
+
|<pre>
 +
{{Backpack item
 +
| item-name = Tux
 +
| limited = yes
 +
| item-kind = Mascot
 +
| item-level = 23
 +
| item-description = Linux represent!
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Tux
 +
| limited = yes
 +
| item-kind = Mascot
 +
| item-level = 23
 +
| item-description = Linux represent!
 +
}}
 +
|-
 +
|<pre>
 +
|{{Backpack item
 +
| item-kind = Rocket Launcher
 +
| grade = Assassin
 +
| wear = Battle Scarred
 +
| skin = Shell Shocker
 +
| item-name  = Rocket Launcher
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-kind = Rocket Launcher
 +
| grade = Assassin
 +
| wear = Battle Scarred
 +
| skin = Shell Shocker
 +
| item-name  = Rocket Launcher
 +
}}
 
|-
 
|-
| {{code|width}}
+
|<pre>
| {{code|75%}}
+
{{Backpack item
| Width parameter. Defaults to {{code|100%}} in infoboxes, but for other usages, can be any value (%, px, pt, em).
+
| item-name = A Hat to Kill For
|
+
| item-kind = Hat
<center>{{Backpack item
+
| grade = Mercenary
| item-name = Jumper's Jeepcap
+
}}
| width = 75%
+
</pre>
 +
|{{Backpack item
 +
| item-name = A Hat to Kill For
 
| item-kind = Hat
 
| item-kind = Hat
}}</center>
+
| grade = Mercenary
 +
}}
 
|-
 
|-
| {{code|style}}
+
|<pre>
| {{code|background: #490040;}}
+
{{Backpack item
| Style parameter. Can add any valid CSS style to the main div.
+
| item-name = Medigun
|
+
| item-kind = Medi Gun
 +
| quality = Strange
 +
| strange-icon = yes
 +
| rankson = Ubers
 +
| killcount = 20
 +
| rankson2 = Kill assists
 +
| killcount2 = 300
 +
| rankson3 = Allied Healing Done
 +
| killcount3 = 10000
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Medigun
 +
| item-kind = Medi Gun
 +
| quality = Strange
 +
| strange-icon = yes
 +
| rankson = Ubers
 +
| killcount = 20
 +
| rankson2 = Kill assists
 +
| killcount2 = 300
 +
| rankson3 = Allied Healing Done
 +
| killcount3 = 10000
 +
}}
 +
|-
 +
|<pre>
 
{{Backpack item
 
{{Backpack item
 
| item-name = Burstchester
 
| item-name = Burstchester
| style = background: #490040;
 
| prefix = Taunt:
 
 
| item-kind = Special Taunt
 
| item-kind = Special Taunt
 +
| rankson = Times Performed
 +
| quality = Strange Unusual
 +
| killcount = 283
 +
| unusual-effect = Mega Strike
 +
| grade = Assassin
 +
| prefix = Strange Unusual Taunt:
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Burstchester
 +
| item-kind = Special Taunt
 +
| rankson = Times Performed
 +
| quality = Strange Unusual
 +
| killcount = 283
 +
| unusual-effect = Mega Strike
 
| grade = Assassin
 
| grade = Assassin
 +
| prefix = Strange Unusual Taunt:
 
}}
 
}}
 
|-
 
|-
 +
|<pre>
 +
{{Backpack item
 +
| item-name = Flame Thrower
 +
| item-kind = Flame Thrower
 +
| quality = Strange
 +
| grade = Mercenary
 +
| wear = Well-Worn
 +
| skin = Forest Fire
 +
| rankson = Kills
 +
| stat-icon = yes
 +
| killcount = 10
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Flame Thrower
 +
| item-kind = Flame Thrower
 +
| quality = Strange
 +
| grade = Mercenary
 +
| wear = Well-Worn
 +
| skin = Forest Fire
 +
| rankson = Kills
 +
| stat-icon = yes
 +
| killcount = 10
 +
}}
 +
|-
 +
|<pre>
 +
{{Backpack item
 +
| item-name = Co-Pilot
 +
| item-kind = Hat
 +
| limited = yes
 +
| quality = Strange
 +
| rankson = points scored
 +
| killcount = 75
 +
| item-description = Winter 2014 Limited Community Cosmetic
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Co-Pilot
 +
| item-kind = Hat
 +
| limited = yes
 +
| quality = Strange
 +
| rankson = points scored
 +
| killcount = 75
 +
| item-description = Winter 2014 Limited Community Cosmetic
 +
}}
 +
|-
 +
|<pre>
 +
{{Backpack item
 +
| item-name = Sniper Rifle
 +
| item-kind = Sniper Rifle
 +
| quality = Strange
 +
| strange-icon = yes
 +
| filter = yukon
 +
| rankson = kills
 +
| killcount = 999
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Sniper Rifle
 +
| item-kind = Sniper Rifle
 +
| quality = Strange
 +
| strange-icon = yes
 +
| filter = yukon
 +
| rankson = kills
 +
| killcount = 999
 +
}}
 +
|-
 +
|<pre>
 +
{{Backpack item
 +
| item-name = Max's Severed Head
 +
| item-kind = Hat
 +
| limited = yes
 +
| paint-color = Team Spirit
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Max's Severed Head
 +
| item-kind = Hat
 +
| limited = yes
 +
| paint-color = Team Spirit
 +
}}
 +
|-
 +
|<pre>
 +
{{Backpack item
 +
| item-name = Photo Badge
 +
| item-kind = Photo Badge
 +
| decal-icon = yes
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| item-name = Photo Badge
 +
| item-kind = Photo Badge
 +
| decal-icon = yes
 +
}}
 +
|-
 +
|<pre>
 +
{{Backpack item
 +
| prefix = The
 +
| item-name = Balloonicorn
 +
| item-kind = Balloon
 +
| item-level = 20
 +
| pyroland-icon = yes
 +
| att-1-positive = On Equip: Visit Pyroland
 +
| att-2-negative = Only visible in Pyroland
 +
}}
 +
</pre>
 +
|{{Backpack item
 +
| prefix = The
 +
| item-name = Balloonicorn
 +
| item-kind = Balloon
 +
| item-level = 20
 +
| pyroland-icon = yes
 +
| att-1-positive = On Equip: Visit Pyroland
 +
| att-2-negative = Only visible in Pyroland
 +
}}
 
|}
 
|}
 
 
== See also ==
 
== See also ==
 
{{Image insertion templates list}}
 
{{Image insertion templates list}}
  
 
<noinclude>[[Category:Template documentation|Backpack item]]</noinclude>
 
<noinclude>[[Category:Template documentation|Backpack item]]</noinclude>

Revision as of 19:46, 26 October 2020

This template is used to display item stats similar to how they appear in-game.

Parameters

Parameter Example Description
item-name Batter's Helmet Proper item name in English (e.g. Batter's Helmet instead of Casque de Batteur). The item name will be automatically translated on language subpages.
custom-name Spam Hammer Adds a custom name with quotation marks. Still needs item-name to produce the correct image.
no-custom-name-quotes yes Removes quotation marks from custom names if the custom-name field is used.
custom-icon File:User Username my item icon.png Adds a custom icon for users' own purposes. This parameter is independent from item-name parameter.
quality normal Defaults to "unique" (the standard item yellow). See Item quality for a list of accepted values.
prefix none
The Best
Set to "none" to hide the "Vintage" or "Community", etc, prefix but keeping the colour. Can also use a custom value, e.g. "prefix = The Best" will generate "The Best Flare Gun".
suffix none
The Best
Same as 'prefix' for non-en pages. Can also use a custom value, e.g. "suffix = The Best" will generate "Flare Gun The Best".
filter Coldfront Adds the appropriate Strange Filter prefix / suffix to the weapon.
paint-color Mann Co. Orange Adds the colored paint 'splat' specified to the top right of the item icon.
unusual-effect Bubbling Adds the Particle Effect icon to the top right of the item's icon. Also adds the "Unusual Effect:" line.
strange-icon yes Adds the Strange/StatTrack icon to the top right of the item's icon.
decal-icon yes Adds this icon to the top right of the item's icon. Only used on the Items page.
Attributes
item-level 50 Item level. Defaults to "1 - 100".
item-kind Hat Item kind. This string is not automatically translated.
no-level yes Optional attribute. If "yes", item level will not be displayed.
limited yes Optional attribute. If "yes", the item name will be colored yellow, the word "Limited" will be added with a link to Limited Quantity.
grade elite Optional attribute. If specified, the item name will be colored correctly for the grade, and the name of the grade will be added before the name, e.g.: Elite Grade Rocket Launcher. Valid options are Civilian, Freelance, Mercenary, Commando, Assassin, Elite
wear factory new Optional attribute, for decorated weapons. Listed in parenthesis after the item name, e.g.: Rocket Launcher (Factory New). Valid options are Battle Scarred, Well-Worn, Field-Tested, Minimal Wear, Factory New.
skin Warhawk Paintkit name. See Template:Dictionary/decorated#Skins for a list of accepted values.
rankson Kills Primary stat method for a strange weapon.
killcount 7616 Number of kills for the primary rank method.
rankson2 Kill assists or Damage dealt Secondary rank method or strange part. rankson3 and rankson4 work similarly.
killcount2 12 Number of kills for the secondary rank method or first strange part. killcount3 and killcount4 work similarly.

att-n-neutral
att-n-positive
att-n-negative

att-1-neutral = Cloak Type: Feign Death
att-2-positive = +80% cloak regen rate
att-3-negative = +60% cloak drain rate
(See section on examples below)

Displays up to 8 positive, negative and neutral values.
item-description It doesn't matter how much people respect you when they're on fire. For items that have an in-game description. This displays the description in a smaller font in order to distinguish from neutral attributes. Will not display if a custom-description is set.
custom-description This hat is the greatest. For items that have a custom in-game description (from a Description Tag). Displays like a normal description but has quotation marks surrounding it.
gift-from Robin Display the source of a gifted item. Displays the text "Gift from: Robin"
date-received Mar 23, 2011 (06:30:00) Display the date a gifted item was received. Will not appear if no gift-from is defined. Displays the text "Date Received: Mar 23, 2011 (06:30:00)"
item-expiration Dec 31, 2010 (23:00:00) For items that expire. Displays the text "This item will expire on Dec 31, 2010 (23:00:00).".
item-uses 5 For items that have "uses". Displays the text "This is a limited item. Uses: 5".
item-flags Not Tradable or Usable in Crafting For item flags. Displays them inside brackets: "( Not Tradable or Usable in Crafting )".
Styling
width 25% Width parameter. Defaults to 100% in infoboxes, but for other usages, can be any value (%, px, pt, em).
style Style parameter. Can add any valid CSS style to the main div.

Examples

Code Output
{{Backpack item
| item-name = Cloak and Dagger
| item-level = 5 
| item-kind = Invis Watch
| att-1-neutral = Cloak Type: Feign Death
| att-2-positive = +80% cloak regen rate
| att-3-negative = +60% cloak drain rate
}}
Backpack Cloak and Dagger.png

Cloak and Dagger
Level 5 Invis Watch
Cloak Type: Feign Death
+80% cloak regen rate
+60% cloak drain rate

{{Backpack item
| item-name = Rocket Launcher
| custom-name = Rawket Lawnchair
| quality = vintage
| item-level = 50
| item-kind = Furniture
| att-1-positive = +20% additional comfort
| att-2-positive = +35% increase in lumbar support
| att-3-negative = +50% increase in financial hardship
| custom-description = For those who favour comfort over fiscal stability.
}}
Backpack Rocket Launcher.png

"Rawket Lawnchair"
Level 50 Furniture
+20% additional comfort
+35% increase in lumbar support
+50% increase in financial hardship
"For those who favour comfort over fiscal stability."

{{Backpack item
| item-name = Wiki Cap
| quality = community
| item-kind = Hat
| item-level = 20
| item-flags = Not Tradable or Usable in Crafting
| unusual-effect = Community Sparkle
| item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 Wiki<br>http://wiki.teamfortress.com/
}}
Viewmode unusual.png
Backpack Wiki Cap.png

Community Wiki Cap
Level 20 Hat
★ Unusual Effect: Community Sparkle
Given to valuable Community Contributors
Given to valuable contributors to the official TF2 Wiki
http://wiki.teamfortress.com/


( Not Tradable or Usable in Crafting )

{{Backpack item
| item-name = Tux
| limited = yes
| item-kind = Mascot
| item-level = 23
| item-description = Linux represent!
}}
Backpack Tux.png

Tux
Limited Level 23 Mascot
Linux represent!

|{{Backpack item
| item-kind = Rocket Launcher
| grade = Assassin
| wear = Battle Scarred
| skin = Shell Shocker
| item-name  = Rocket Launcher
}}
Backpack Shell Shocker Rocket Launcher Battle Scarred.png

Shell Shocker Rocket Launcher
Assassin Grade Rocket Launcher (Battle Scarred)

{{Backpack item
| item-name = A Hat to Kill For
| item-kind = Hat
| grade = Mercenary
}}
Backpack A Hat to Kill For.png

A Hat to Kill For
Mercenary Grade Hat
Hat

{{Backpack item
| item-name = Medigun
| item-kind = Medi Gun
| quality = Strange
| strange-icon = yes
| rankson = Ubers
| killcount = 20
| rankson2 = Kill assists
| killcount2 = 300
| rankson3 = Allied Healing Done
| killcount3 = 10000
}}
Viewmode strange.png
Backpack Medi Gun.png

Unremarkable Medi Gun
Unremarkable Medi Gun - Ubers: 20
(Kill Assists: 300)
(Allied Healing Done: 10000)

{{Backpack item
| item-name = Burstchester
| item-kind = Special Taunt
| rankson = Times Performed
| quality = Strange Unusual
| killcount = 283
| unusual-effect = Mega Strike
| grade = Assassin
| prefix = Strange Unusual Taunt:
}}
Viewmode unusual.png
Backpack Burstchester.png

Strange Unusual Taunt: Burstchester
Assassin Grade Special Taunt
Special Taunt - Times Performed: 283

★ Unusual Effect: Mega Strike

{{Backpack item
| item-name = Flame Thrower
| item-kind = Flame Thrower
| quality = Strange
| grade = Mercenary
| wear = Well-Worn
| skin = Forest Fire
| rankson = Kills
| stat-icon = yes
| killcount = 10
}}
Viewmode statclock.png
Backpack Forest Fire Flame Thrower Well-Worn.png

Unremarkable Forest Fire Flame Thrower
Mercenary Grade Flame Thrower (Well-Worn)
Unremarkable Stat Clock Attached
Kills: 10

{{Backpack item
| item-name = Co-Pilot
| item-kind = Hat
| limited = yes
| quality = Strange
| rankson = points scored
| killcount = 75
| item-description = Winter 2014 Limited Community Cosmetic
}}
Backpack Co-Pilot.png

Odious Co-Pilot
Limited Odious Hat - Points Scored: 75
Winter 2014 Limited Community Cosmetic

{{Backpack item
| item-name = Sniper Rifle
| item-kind = Sniper Rifle
| quality = Strange
| strange-icon = yes
| filter = yukon
| rankson = kills
| killcount = 999
}}
Viewmode strange.png
Backpack Sniper Rifle.png

Totally Ordinary Canadian Sniper Rifle
Totally Ordinary Sniper Rifle - Kills: 999

{{Backpack item
| item-name = Max's Severed Head
| item-kind = Hat
| limited = yes
| paint-color = Team Spirit
}}
Paint Splat TeamSpirit.png
Backpack Max's Severed Head.png

Max's Severed Head
Limited Level 1 - 100 Hat

{{Backpack item
| item-name = Photo Badge
| item-kind = Photo Badge
| decal-icon = yes
}}
Paint Splat Decal.png
Backpack Photo Badge.png

Photo Badge
Level 1 - 100 Photo Badge

{{Backpack item
| prefix = The
| item-name = Balloonicorn
| item-kind = Balloon
| item-level = 20
| pyroland-icon = yes
| att-1-positive = On Equip: Visit Pyroland
| att-2-negative = Only visible in Pyroland
}}
Viewmode pyrovision.png
Backpack Balloonicorn.png

The Balloonicorn
Level 20 Balloon
On Equip: Visit Pyroland
Only visible in Pyroland

See also

Image insertion templatesview  edit )