Difference between revisions of "Template:Backpack item/doc"
(test) |
GrampaSwood (talk | contribs) m (Changed to dev name rather than user's name) |
||
(18 intermediate revisions by 5 users not shown) | |||
Line 4: | Line 4: | ||
== Parameters == | == Parameters == | ||
{| class="wikitable grid" | {| class="wikitable grid" | ||
− | ! width=" | + | ! width="10%" class="header" | Parameter |
− | ! width=" | + | ! width="10%" class="header" | Example |
− | ! width="25%" class="header" | | + | ! width="20%" class="header" | Description |
+ | ! width="25%" class="header" | Code Example | ||
! class="header" | Result | ! class="header" | Result | ||
|- | |- | ||
− | ! style="text-align:left;" class="header" colspan=" | + | ! style="text-align:left;" class="header" colspan="5" | ''Basics'' |
|- | |- | ||
| {{code|item-name}} | | {{code|item-name}} | ||
| {{code|Condor Cap}} | | {{code|Condor Cap}} | ||
− | | Proper item name in English (Condor Cap instead of Bonnet de condor). Automatically grabs the item's icon. The item name | + | | Proper item name in English (Condor Cap instead of Bonnet de condor, for example). Automatically grabs the item's icon. The item name is automatically translated on any language subpages. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Condor Cap | ||
+ | | item-kind = Hat | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 23: | Line 29: | ||
| {{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 [[Name Tag|custom name]] with quotation marks. Still needs {{code|item-name}} to produce the correct image. | ||
+ | | | ||
+ | <pre>{{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 | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 36: | Line 52: | ||
| {{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. | + | | Removes quotation marks from custom names if the {{code|custom-name}} field is used. Used in conjunction with {{code|custom-name}}. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Texas Slim's Dome Shine | ||
+ | | custom-name = Cream Gravy | ||
+ | | no-custom-name-quotes = yes | ||
+ | | item-kind = Hat | ||
+ | | item-description = Sometimes you just need a little less hat. | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
| item-name = Texas Slim's Dome Shine | | item-name = Texas Slim's Dome Shine | ||
− | | custom-name = | + | | custom-name = Cream Gravy |
| no-custom-name-quotes = yes | | no-custom-name-quotes = yes | ||
| item-kind = Hat | | item-kind = Hat | ||
Line 49: | Line 73: | ||
| {{code|BLU Bombcart.png}} | | {{code|BLU Bombcart.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. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Mr. Quackers | ||
+ | | custom-icon = BLU Bombcart.png | ||
+ | | item-kind = Mask | ||
+ | | grade = Assassin | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 57: | Line 88: | ||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|item-description}} |
− | | {{code| | + | | {{code|This hat is the greatest.}} |
− | | | + | | For items that have an in-game description. Will not display if a {{code|custom-description}} is set. Can use a custom value. |
− | | | + | | |
+ | <pre>{{Backpack item | ||
+ | | item-name = Yule Hog | ||
+ | | item-kind = Hat | ||
+ | | grade = Mercenary | ||
+ | | item-description = This hat is the greatest. | ||
+ | }}</pre> | ||
+ | | | ||
+ | {{Backpack item | ||
+ | | item-name = Yule Hog | ||
+ | | item-kind = Hat | ||
+ | | grade = Mercenary | ||
+ | | item-description = This hat is the greatest. | ||
+ | }} | ||
+ | |- | ||
+ | | {{code|custom-description}} | ||
+ | | {{code|This hat is also 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. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Napper's Respite | ||
+ | | item-kind = Hat | ||
+ | | custom-description = This hat is also the greatest. | ||
+ | }}</pre> | ||
+ | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Napper's Respite |
− | + | | item-kind = Hat | |
− | | item-kind = | + | | custom-description = This hat is also the greatest. |
− | | | ||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
|- | |- | ||
Line 75: | Line 125: | ||
| {{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 any prefix added by {{code|quality}}, while keeping the quality's color. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{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 | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 88: | Line 147: | ||
| {{code|none}}<br>{{code|(Slight Return)}} | | {{code|none}}<br>{{code|(Slight Return)}} | ||
| Similar to {{code|prefix}}, mainly for use in non-en pages. Can use a custom value. | | Similar to {{code|prefix}}, mainly for use in non-en pages. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{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. | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 99: | Line 168: | ||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|item-level}} |
− | | {{code| | + | | {{code|68}}<br>| {{code|none}} |
− | | | + | | 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. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Antarctic Researcher | ||
+ | | prefix = The | ||
+ | | item-kind = Coat | ||
+ | | item-level = 68 | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Antarctic Researcher |
− | | | + | | prefix = The |
− | + | | item-kind = Coat | |
− | + | | item-level = 68 | |
− | |||
− | |||
− | | item-kind | ||
− | | item-level = | ||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|item-kind}} |
− | | {{code| | + | | {{code|Hat}} |
− | | | + | | Item kind. This string is not automatically translated. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Lucky Cat Hat | ||
+ | | grade = Elite | ||
+ | | item-kind = Absolute Meower | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Lucky Cat Hat |
− | | | + | | grade = Elite |
− | | | + | | item-kind = Absolute Meower |
− | | item-kind = | + | }} |
− | | | + | |- |
+ | ! style="text-align:left;" class="header" colspan="5" | ''Quality'' | ||
+ | |- | ||
+ | | {{code|quality}} | ||
+ | | {{code|genuine}} | ||
+ | | Defaults to "{{code|unique}}" (the standard item yellow). See [[Item quality]] for a list of accepted values. | ||
+ | | | ||
+ | <pre>{{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 | ||
+ | }}</pre> | ||
+ | | | ||
+ | {{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 | ||
}} | }} | ||
|- | |- | ||
Line 129: | Line 233: | ||
| {{code|Stormy Storm}} | | {{code|Stormy Storm}} | ||
| 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 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. | ||
+ | | | ||
+ | <pre>{{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!' | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 138: | Line 250: | ||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|rankson}} |
− | | {{code| | + | | {{code|Buildings Sapped}} |
− | | | + | | Primary stat being tracked for a Strange item. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Shovel | ||
+ | | strange-icon = yes | ||
+ | | rankson = Buildings Sapped | ||
+ | | killcount = 0 | ||
+ | | quality = strange | ||
+ | | item-kind = Shovel | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Shovel |
| strange-icon = yes | | strange-icon = yes | ||
− | | rankson = | + | | rankson = Buildings Sapped |
| killcount = 0 | | killcount = 0 | ||
| quality = strange | | quality = strange | ||
− | | item-kind = | + | | item-kind = Shovel |
− | | item- | + | }} |
− | | | + | |- |
− | | item-description = | + | | {{code|killcount}} |
+ | | {{code|7613}} | ||
+ | | Number of points for the primary stat being tracked. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{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. | ||
+ | }}</pre> | ||
+ | | | ||
+ | {{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| | + | | {{code|rankson2}} |
− | | {{code| | + | | {{code|Kill assists}} |
− | | | + | | For [[Strange Part]]s or the secondary stat being tracked. {{code|rankson3}} and {{code|rankson4}} work similarly. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Medi Gun | ||
+ | | strange-icon = yes | ||
+ | | rankson = Ubers | ||
+ | | rankson2 = Kill Assists | ||
+ | | killcount = 0 | ||
+ | | killcount2 = 0 | ||
+ | | quality = strange | ||
+ | | item-kind = Medi Gun | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Medi Gun |
− | | | + | | strange-icon = yes |
− | | | + | | rankson = Ubers |
− | | | + | | rankson2 = Kill Assists |
− | | item- | + | | killcount = 0 |
+ | | killcount2 = 0 | ||
+ | | quality = strange | ||
+ | | item-kind = Medi Gun | ||
}} | }} | ||
|- | |- | ||
− | + | | {{code|killcount2}} | |
− | | | + | | {{code|50}} |
− | + | | Number of points for Strange Parts or the secondary stat being tracked. {{code|killcount3}} and {{code|killcount4}} work similarly. Can use a custom value. | |
− | + | | | |
− | | | + | <pre>{{Backpack item |
+ | | item-name = Sniper Rifle | ||
+ | | strange-icon = yes | ||
+ | | rankson = Kills | ||
+ | | rankson2 = Damage Dealt | ||
+ | | killcount = 0 | ||
+ | | killcount2 = 50 | ||
+ | | quality = strange | ||
+ | | item-kind = Sniper Rifle | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Sniper Rifle |
− | | | + | | strange-icon = yes |
− | | | + | | rankson = Kills |
− | | item- | + | | rankson2 = Damage Dealt |
+ | | killcount = 0 | ||
+ | | killcount2 = 50 | ||
+ | | quality = strange | ||
+ | | item-kind = Sniper Rifle | ||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|filter}} |
− | | {{code| | + | | {{code|Coldfront}} |
− | | | + | | Adds the appropriate [[Strange Filter]] prefix/suffix to the weapon. See [[List of maps]] for a list of accepted values. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Shotgun | ||
+ | | filter = Coldfront | ||
+ | | strange-icon = yes | ||
+ | | rankson = kills | ||
+ | | killcount = 0 | ||
+ | | quality = strange | ||
+ | | item-kind = Shotgun | ||
+ | | item-level = 1 | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Shotgun |
− | | | + | | filter = Coldfront |
− | | item-kind = | + | | strange-icon = yes |
+ | | rankson = kills | ||
+ | | killcount = 0 | ||
+ | | quality = strange | ||
+ | | item-kind = Shotgun | ||
+ | | item-level = 1 | ||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|strange-icon}} |
| {{code|yes}} | | {{code|yes}} | ||
− | | | + | | Adds an icon at the top right of the item icon, indicating the item is [[Strange]]. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Scattergun | ||
+ | | strange-icon = yes | ||
+ | | rankson = kills | ||
+ | | killcount = 0 | ||
+ | | quality = strange | ||
+ | | item-kind = Scattergun | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Scattergun |
− | | | + | | strange-icon = yes |
− | | | + | | rankson = kills |
− | | item- | + | | killcount = 0 |
+ | | quality = strange | ||
+ | | item-kind = Scattergun | ||
}} | }} | ||
|- | |- | ||
Line 203: | Line 399: | ||
| {{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]]. | | 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]]. | ||
+ | | | ||
+ | <pre>{{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! | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 213: | Line 416: | ||
| {{code|grade}} | | {{code|grade}} | ||
| {{code|Commando}} | | {{code|Commando}} | ||
− | | Colors the item's name according to the specified [[grade]], and treats it like a graded item. Valid options are | + | | Colors the item's name according to the specified [[grade]], and treats it like a graded item. Valid options are {{code|Civilian}}, {{code|Freelance}}, {{code|Mercenary}}, {{code|Commando}}, {{code|Assassin}}, and {{code|Elite}}. |
+ | | | ||
+ | <pre>{{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 | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 225: | Line 436: | ||
| {{code|wear}} | | {{code|wear}} | ||
| {{code|Field-Tested}} | | {{code|Field-Tested}} | ||
− | | For use on [[Decorated]] weapons. Valid options are | + | | For use on [[Decorated]] weapons. Valid options are {{code|Battle Scarred}}, {{code|Well-Worn}}, {{code|Field-Tested}}, {{code|Minimal Wear}}, and {{code|Factory New}}. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Minigun | ||
+ | | wear = Field-Tested | ||
+ | | skin = War Room | ||
+ | | grade = Commando | ||
+ | | item-kind = Minigun | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 238: | Line 457: | ||
| {{code|Warhawk}} | | {{code|Warhawk}} | ||
| Decorated skin name. See [[Template:Dictionary/decorated#Skins]] for a list of accepted values. | | Decorated skin name. See [[Template:Dictionary/decorated#Skins]] for a list of accepted values. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Rocket Launcher | ||
+ | | wear = Factory New | ||
+ | | skin = Warhawk | ||
+ | | grade = Elite | ||
+ | | item-kind = Rocket Launcher | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 247: | Line 474: | ||
}} | }} | ||
|- | |- | ||
− | | {{code|rankson}} | + | | {{code|stat-icon}} |
− | | {{code| | + | | {{code|yes}} |
− | | | + | | Adds an icon at the top right of the backpack image, indicating the item is [[Grade]]d and [[Strange]]. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Revolver | ||
+ | | wear = Factory New | ||
+ | | skin = Blitzkrieg | ||
+ | | grade = Mercenary | ||
+ | | quality = Strange | ||
+ | | stat-icon = yes | ||
+ | | rankson = kills | ||
+ | | killcount = 25 | ||
+ | | item-kind = Revolver | ||
+ | }}</pre> | ||
+ | | | ||
+ | {{Backpack item | ||
+ | | item-name = Revolver | ||
+ | | wear = Factory New | ||
+ | | skin = Blitzkrieg | ||
+ | | grade = Mercenary | ||
+ | | quality = Strange | ||
+ | | stat-icon = yes | ||
+ | | rankson = kills | ||
+ | | killcount = 25 | ||
+ | | item-kind = Revolver | ||
+ | }} | ||
+ | |- | ||
+ | | {{code|pyroland-icon}} | ||
+ | | {{code|yes}} | ||
+ | | Adds an icon at the top right of the backpack image, indicating the item is only visible in [[Pyroland]]. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Pyrovision Goggles | ||
+ | | item-kind = Pyrovision Goggles | ||
+ | | item-level = 1-100 | ||
+ | | pyroland-icon = yes | ||
+ | | item-description = Enter a world of imagination that's far superior to the crap-ass worlds of imagination you get from books. Pyrovision lets you see the TF2niverse from our favorite arsonist's perspective. | ||
+ | | item-flags = Achievement Item: Not Tradable or Marketable | ||
+ | | att-1-positive = On Equip: Visit Pyroland | ||
+ | }}</pre> | ||
+ | | | ||
+ | {{Backpack item | ||
+ | | item-name = Pyrovision Goggles | ||
+ | | item-kind = Pyrovision Goggles | ||
+ | | item-level = 1-100 | ||
+ | | pyroland-icon = yes | ||
+ | | item-description = Enter a world of imagination that's far superior to the crap-ass worlds of imagination you get from books. Pyrovision lets you see the TF2niverse from our favorite arsonist's perspective. | ||
+ | | item-flags = Achievement Item: Not Tradable or Marketable | ||
+ | | att-1-positive = On Equip: Visit Pyroland | ||
+ | }} | ||
+ | |- | ||
+ | | {{code|halloween-icon}} | ||
+ | | {{code|yes}} | ||
+ | | Adds an icon at the top right of the backpack image, indicating the item is only visible during [[Halloween]]/[[Full Moon]]. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Chicken Kiev | ||
+ | | prefix = The | ||
+ | | item-kind = Bird Head | ||
+ | | halloween-icon = yes | ||
+ | | att-1-negative = Holiday Restriction: Halloween / Full Moon | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Chicken Kiev |
− | | | + | | prefix = The |
− | | | + | | item-kind = Bird Head |
− | | | + | | halloween-icon = yes |
− | | | + | | att-1-negative = Holiday Restriction: Halloween / Full Moon |
− | |||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|loaner-icon}} |
− | | {{code| | + | | {{code|yes}} |
− | | | + | | Adds an icon at the top right of the backpack image, indicating the item is being [[Loaner Program|loaned]]. |
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Black Box | ||
+ | | item-kind = Rocket Launcher | ||
+ | | item-level = 5 | ||
+ | | loaner-icon = yes | ||
+ | | prefix = The | ||
+ | | att-1-positive = On Hit: Gain up to +20 health per attack | ||
+ | | att-2-negative = -25% clip size | ||
+ | | item-flags = Loaner - Cannot be traded, marketed, crafted, or modified | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Black Box |
− | | | + | | item-kind = Rocket Launcher |
− | | | + | | item-level = 5 |
− | | | + | | loaner-icon = yes |
− | | | + | | prefix = The |
− | | | + | | att-1-positive = On Hit: Gain up to +20 health per attack |
− | | item- | + | | att-2-negative = -25% clip size |
+ | | item-flags = Loaner - Cannot be traded, marketed, crafted, or modified | ||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | ! style="text-align:left;" class="header" colspan="5" | ''Attributes'' |
− | | {{code| | + | |- |
− | | | + | | {{code|paint-color}} |
+ | | {{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. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Mislaid Sweater | ||
+ | | paint-color = Mann Co. Orange | ||
+ | | prefix = The | ||
+ | | item-kind = Sweater | ||
+ | | grade = commando | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Mislaid Sweater |
− | | | + | | paint-color = Mann Co. Orange |
− | | | + | | prefix = The |
− | | | + | | item-kind = Sweater |
− | + | | grade = commando | |
− | | | ||
− | |||
− | |||
}} | }} | ||
|- | |- | ||
− | | {{code| | + | | {{code|decal-icon}} |
− | | {{code| | + | | {{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. |
+ | | | ||
+ | <pre>{{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. | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | 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. | |
− | |||
− | |||
− | | item- | ||
}} | }} | ||
|- | |- | ||
Line 314: | Line 624: | ||
| Displays up to 8 positive, negative, or neutral values. Can use custom values. | | Displays up to 8 positive, negative, or neutral values. Can use custom values. | ||
| | | | ||
− | {{Backpack item | + | <pre>{{Backpack item |
| item-name = Dead Ringer | | item-name = Dead Ringer | ||
| item-kind = Invis Watch | | item-kind = Invis Watch | ||
Line 321: | Line 631: | ||
| att-2-positive = Live forever! | | att-2-positive = Live forever! | ||
| att-3-negative = Just kidding. | | att-3-negative = Just kidding. | ||
− | }} | + | }}</pre> |
− | |||
− | |||
− | |||
− | |||
| | | | ||
{{Backpack item | {{Backpack item | ||
− | | item-name = | + | | item-name = Dead Ringer |
− | | item-kind = | + | | item-kind = Invis Watch |
− | + | | item-level = 5 | |
− | | item- | + | | att-1-neutral = Cloak Type: Feign Death |
− | + | | att-2-positive = Live forever! | |
− | |- | + | | att-3-negative = Just kidding. |
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | | | ||
− | |||
}} | }} | ||
|- | |- | ||
Line 347: | Line 645: | ||
| {{code|Robin}} | | {{code|Robin}} | ||
| Display the source of a gifted item. Can use a custom value. | | Display the source of a gifted item. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Robin Walkers | ||
+ | | item-kind = Slippers | ||
+ | | grade = Elite | ||
+ | | gift-from = Robin | ||
+ | | date-received = Mar 29, 2018 (21:43:08) | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 359: | Line 665: | ||
| {{code|Sep 13, 2188 (06:30:00)}} | | {{code|Sep 13, 2188 (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. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Level Three Chin | ||
+ | | item-kind = Chin | ||
+ | | prefix = The | ||
+ | | item-level = 3 | ||
+ | | gift-from = Gabe Newell | ||
+ | | date-received = Sep 13, 2188 (06:30:00) | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 365: | Line 680: | ||
| prefix = The | | prefix = The | ||
| item-level = 3 | | item-level = 3 | ||
− | | gift-from = | + | | gift-from = Gabe Newell |
| date-received = Sep 13, 2188 (06:30:00) | | date-received = Sep 13, 2188 (06:30:00) | ||
}} | }} | ||
Line 372: | Line 687: | ||
| {{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. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Gift-Stuffed Stocking | ||
+ | | item-uses = 1 | ||
+ | | item-level = 13 | ||
+ | | item-kind = Gift | ||
+ | | item-flags = Not Tradable or Marketable | ||
+ | | item-description = Contains an assortment of goodies for good little Mercenaries. | ||
+ | | item-expiration = Dec 31, 2010 (23:00:00) | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 386: | Line 711: | ||
| {{code|4}} | | {{code|4}} | ||
| For items that have a limited number of uses. Can use a custom value. | | For items that have a limited number of uses. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Noise Maker - Black Cat | ||
+ | | item-uses = 4 | ||
+ | | item-level = 5 | ||
+ | | item-kind = Party Favor | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 397: | Line 729: | ||
| {{code|Not Tradable, Marketable, or Usable in Crafting}} | | {{code|Not Tradable, Marketable, or Usable in Crafting}} | ||
| For item flags. Displays them inside brackets. Can use a custom value. | | For item flags. Displays them inside brackets. Can use a custom value. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Wiki Cap | ||
+ | | quality = community | ||
+ | | item-kind = Hat | ||
+ | | item-level = 20 | ||
+ | | unusual-effect = Community Sparkle | ||
+ | | item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 wiki<br><nowiki>https://wiki.teamfortress.com/</nowiki> | ||
+ | | item-flags = Not Tradable, Marketable, or Usable in Crafting | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 404: | Line 746: | ||
| item-level = 20 | | item-level = 20 | ||
| unusual-effect = Community Sparkle | | unusual-effect = Community Sparkle | ||
− | | item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 wiki<br><nowiki> | + | | item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 wiki<br><nowiki>https://wiki.teamfortress.com/</nowiki> |
| item-flags = Not Tradable, Marketable, or Usable in Crafting | | item-flags = Not Tradable, Marketable, or Usable in Crafting | ||
}} | }} | ||
|- | |- | ||
− | ! style="text-align:left;" class="header" colspan=" | + | ! style="text-align:left;" class="header" colspan="5" | ''Styling'' |
|- | |- | ||
| {{code|width}} | | {{code|width}} | ||
| {{code|75%}} | | {{code|75%}} | ||
| Width parameter. Defaults to {{code|100%}} in infoboxes, but for other usages, can be any value (%, px, pt, em). | | Width parameter. Defaults to {{code|100%}} in infoboxes, but for other usages, can be any value (%, px, pt, em). | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Jumper's Jeepcap | ||
+ | | width = 75% | ||
+ | | item-kind = Hat | ||
+ | }}</pre> | ||
| | | | ||
<center>{{Backpack item | <center>{{Backpack item | ||
Line 423: | Line 771: | ||
| {{code|background: #490040;}} | | {{code|background: #490040;}} | ||
| Style parameter. Can add any valid CSS style to the main div. | | Style parameter. Can add any valid CSS style to the main div. | ||
+ | | | ||
+ | <pre>{{Backpack item | ||
+ | | item-name = Burstchester | ||
+ | | style = background: #490040; | ||
+ | | prefix = Taunt: | ||
+ | | item-kind = Special Taunt | ||
+ | | grade = Assassin | ||
+ | | item-description = Community Created All Class Taunt | ||
+ | }}</pre> | ||
| | | | ||
{{Backpack item | {{Backpack item | ||
Line 430: | Line 787: | ||
| item-kind = Special Taunt | | item-kind = Special Taunt | ||
| grade = Assassin | | grade = Assassin | ||
+ | | item-description = Community Created All Class Taunt | ||
}} | }} | ||
|- | |- |
Latest revision as of 13:04, 8 September 2023
This template is used to display item stats similar to how they appear in-game.
Parameters
Parameter | Example | Description | Code Example | Result |
---|---|---|---|---|
Basics | ||||
item-name
|
Condor Cap
|
Proper item name in English (Condor Cap instead of Bonnet de condor, for example). Automatically grabs the item's icon. The item name is automatically translated on any language subpages. |
{{Backpack item | item-name = Condor Cap | item-kind = Hat }} |
|
custom-name
|
Spam Hammer
|
Adds a custom name with quotation marks. Still needs 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 }} |
|
no-custom-name-quotes
|
yes
|
Removes quotation marks from custom names if the custom-name field is used. Used in conjunction with custom-name .
|
{{Backpack item | item-name = Texas Slim's Dome Shine | custom-name = Cream Gravy | no-custom-name-quotes = yes | item-kind = Hat | item-description = Sometimes you just need a little less hat. }} |
|
custom-icon
|
BLU Bombcart.png
|
Adds a custom icon for users' own purposes. This parameter is independent from item-name parameter.
|
{{Backpack item | item-name = Mr. Quackers | custom-icon = BLU Bombcart.png | item-kind = Mask | grade = Assassin }} |
|
item-description
|
This hat is the greatest.
|
For items that have an in-game description. Will not display if a custom-description is set. Can use a custom value.
|
{{Backpack item | item-name = Yule Hog | item-kind = Hat | grade = Mercenary | item-description = This hat is the greatest. }} |
|
custom-description
|
This hat is also 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. |
{{Backpack item | item-name = Napper's Respite | item-kind = Hat | custom-description = This hat is also the greatest. }} |
|
prefix
|
none The Best
|
Set to "none" to hide any prefix added by quality , while keeping the quality's color. Can use a custom value.
|
{{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 }} |
|
suffix
|
none (Slight Return)
|
Similar to prefix , mainly for use in non-en pages. Can use a custom value.
|
{{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. }} |
|
item-level
|
none
|
The item's level. Set to "none" to hide the level. Defaults to "Level 1 - 100". Can use a custom value. |
{{Backpack item | item-name = Antarctic Researcher | prefix = The | item-kind = Coat | item-level = 68 }} |
|
item-kind
|
Hat
|
Item kind. This string is not automatically translated. |
{{Backpack item | item-name = Lucky Cat Hat | grade = Elite | item-kind = Absolute Meower }} |
|
Quality | ||||
quality
|
genuine
|
Defaults to "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 }} |
|
unusual-effect
|
Stormy Storm
|
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. |
{{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!' }} |
|
rankson
|
Buildings Sapped
|
Primary stat being tracked for a Strange item. |
{{Backpack item | item-name = Shovel | strange-icon = yes | rankson = Buildings Sapped | killcount = 0 | quality = strange | item-kind = Shovel }} |
|
killcount
|
7613
|
Number of points for the primary stat being tracked. Can use a custom value. |
{{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. }} |
|
rankson2
|
Kill assists
|
For Strange Parts or the secondary stat being tracked. rankson3 and 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 }} |
|
killcount2
|
50
|
Number of points for Strange Parts or the secondary stat being tracked. killcount3 and killcount4 work similarly. Can use a custom value.
|
{{Backpack item | item-name = Sniper Rifle | strange-icon = yes | rankson = Kills | rankson2 = Damage Dealt | killcount = 0 | killcount2 = 50 | quality = strange | item-kind = Sniper Rifle }} |
|
filter
|
Coldfront
|
Adds the appropriate Strange Filter prefix/suffix to the weapon. See List of maps for a list of accepted values. |
{{Backpack item | item-name = Shotgun | filter = Coldfront | strange-icon = yes | rankson = kills | killcount = 0 | quality = strange | item-kind = Shotgun | item-level = 1 }} |
|
strange-icon
|
yes
|
Adds an icon at the top right of the item icon, indicating the item is Strange. |
{{Backpack item | item-name = Scattergun | strange-icon = yes | rankson = kills | killcount = 0 | quality = strange | item-kind = Scattergun }} |
|
limited
|
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. |
{{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! }} |
Batter's Helmet |
grade
|
Commando
|
Colors the item's name according to the specified grade, and treats it like a graded item. Valid options are Civilian , Freelance , Mercenary , Commando , Assassin , and Elite .
|
{{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 }} |
|
wear
|
Field-Tested
|
For use on Decorated weapons. Valid options are Battle Scarred , Well-Worn , Field-Tested , Minimal Wear , and Factory New .
|
{{Backpack item | item-name = Minigun | wear = Field-Tested | skin = War Room | grade = Commando | item-kind = Minigun }} |
|
skin
|
Warhawk
|
Decorated skin 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 }} |
|
stat-icon
|
yes
|
Adds an icon at the top right of the backpack image, indicating the item is Graded and Strange. |
{{Backpack item | item-name = Revolver | wear = Factory New | skin = Blitzkrieg | grade = Mercenary | quality = Strange | stat-icon = yes | rankson = kills | killcount = 25 | item-kind = Revolver }} |
|
pyroland-icon
|
yes
|
Adds an icon at the top right of the backpack image, indicating the item is only visible in Pyroland. |
{{Backpack item | item-name = Pyrovision Goggles | item-kind = Pyrovision Goggles | item-level = 1-100 | pyroland-icon = yes | item-description = Enter a world of imagination that's far superior to the crap-ass worlds of imagination you get from books. Pyrovision lets you see the TF2niverse from our favorite arsonist's perspective. | item-flags = Achievement Item: Not Tradable or Marketable | att-1-positive = On Equip: Visit Pyroland }} |
Pyrovision Goggles |
halloween-icon
|
yes
|
Adds an icon at the top right of the backpack image, indicating the item is only visible during Halloween/Full Moon. |
{{Backpack item | item-name = Chicken Kiev | prefix = The | item-kind = Bird Head | halloween-icon = yes | att-1-negative = Holiday Restriction: Halloween / Full Moon }} |
|
loaner-icon
|
yes
|
Adds an icon at the top right of the backpack image, indicating the item is being loaned. |
{{Backpack item | item-name = Black Box | item-kind = Rocket Launcher | item-level = 5 | loaner-icon = yes | prefix = The | att-1-positive = On Hit: Gain up to +20 health per attack | att-2-negative = -25% clip size | item-flags = Loaner - Cannot be traded, marketed, crafted, or modified }} |
|
Attributes | ||||
paint-color
|
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. |
{{Backpack item | item-name = Mislaid Sweater | paint-color = Mann Co. Orange | prefix = The | item-kind = Sweater | grade = commando }} |
|
decal-icon
|
yes
|
Adds this icon at the top right of the item icon, indicating the item has a Decal applied. |
{{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. }} |
|
|
|
Displays up to 8 positive, negative, or neutral values. Can use custom 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. }} |
|
gift-from
|
Robin
|
Display the source of a gifted item. Can use a custom value. |
{{Backpack item | item-name = Robin Walkers | item-kind = Slippers | grade = Elite | gift-from = Robin | date-received = Mar 29, 2018 (21:43:08) }} |
|
date-received
|
Sep 13, 2188 (06:30:00)
|
Display the date a gifted item was received. Will not appear if no gift-from is defined. Can use a custom value.
|
{{Backpack item | item-name = Level Three Chin | item-kind = Chin | prefix = The | item-level = 3 | gift-from = Gabe Newell | date-received = Sep 13, 2188 (06:30:00) }} |
|
item-expiration
|
Dec 31, 2010 (23:00:00)
|
For items that expire. Can use a custom value. |
{{Backpack item | item-name = Gift-Stuffed Stocking | item-uses = 1 | item-level = 13 | item-kind = Gift | item-flags = Not Tradable or Marketable | item-description = Contains an assortment of goodies for good little Mercenaries. | item-expiration = Dec 31, 2010 (23:00:00) }} |
|
item-uses
|
4
|
For items that have a limited number of uses. Can use a custom value. |
{{Backpack item | item-name = Noise Maker - Black Cat | item-uses = 4 | item-level = 5 | item-kind = Party Favor }} |
|
item-flags
|
Not Tradable, Marketable, or Usable in Crafting
|
For item flags. Displays them inside brackets. Can use a custom value. |
{{Backpack item | item-name = Wiki Cap | quality = community | item-kind = Hat | item-level = 20 | unusual-effect = Community Sparkle | item-description = Given to valuable Community Contributors<br>Given to valuable contributors to the official TF2 wiki<br>https://wiki.teamfortress.com/ | item-flags = Not Tradable, Marketable, or Usable in Crafting }} |
|
Styling | ||||
width
|
75%
|
Width parameter. Defaults to 100% in infoboxes, but for other usages, can be any value (%, px, pt, em).
|
{{Backpack item | item-name = Jumper's Jeepcap | width = 75% | item-kind = Hat }} |
|
style
|
background: #490040;
|
Style parameter. Can add any valid CSS style to the main div. |
{{Backpack item | item-name = Burstchester | style = background: #490040; | prefix = Taunt: | item-kind = Special Taunt | grade = Assassin | item-description = Community Created All Class Taunt }} |
See also
Image insertion templates (
)- Team Fortress 2
{{Backpack icon}}
– for inserting an image from the backpack.{{Backpack item}}
– for displaying loadout stats.{{Icon class}}
– for displaying class icons.{{Icon item}}
– for displaying images from the item icons done in Shugo style.{{Icon killicon}}
– for displaying kill icon images.{{Kill notice}}
– for displaying a kill notice.
- Wiki-related
{{Possession}}
– for displaying the icons used in{{Item checklist}}
.{{User halloween mask possession}}
– for displaying Halloween Mask icons used in hat and item checklists.{{Comment}}
– for displaying "Support", "Oppose" and "Comment" symbols.{{Pro}}
,{{Con}}
&{{Neut}}
; Compact form for common uses of{{Comment}}
{{Flagicon}}
– generates the flag icon of a country when given the country code.