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

From Team Fortress Wiki
Jump to: navigation, search
Line 53: Line 53:
 
|-
 
|-
 
| {{code|item-description}}
 
| {{code|item-description}}
 +
| {{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.
 +
|-
 +
| {{code|custom-description}}
 
| {{code|This hat is the greatest.}}
 
| {{code|This hat is the greatest.}}
| For items that have an in-game description. This displays the description in a smaller font in order to distinguish from neutral attributes.
+
| For items that have a custom in-game description (from a [[Description Tag]]). Displays like a normal description but has quotation marks surrounding it.
 
|-
 
|-
 
| {{code|gift-from}}
 
| {{code|gift-from}}
Line 153: Line 157:
 
| att-2-positive = +35% increase in lumbar support
 
| att-2-positive = +35% increase in lumbar support
 
| att-3-negative = +50% increase in financial hardship
 
| att-3-negative = +50% increase in financial hardship
| item-description = For those who favour comfort over fiscal stability.
+
| custom-description = For those who favour comfort over fiscal stability.
 
| width = 50%
 
| width = 50%
 
}}
 
}}
Line 169: Line 173:
 
| att-2-positive = +35% increase in lumbar support
 
| att-2-positive = +35% increase in lumbar support
 
| att-3-negative = +50% increase in financial hardship
 
| att-3-negative = +50% increase in financial hardship
| item-description = For those who favour comfort over fiscal stability.
+
| custom-description = For those who favour comfort over fiscal stability.
 
| width = 50%
 
| width = 50%
 
}}
 
}}

Revision as of 00:34, 20 May 2011

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.
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 all accepted values in the list below.
prefix none
The Best
Set to "none" to hide the "Vintage" or "Community", etc, prefix but keeping the colour (necessary for language pages). Can also use a custom value, e.g. "prefix = The Best" will generate "The Best Flare Gun".
paint-color 7C6C57 Adds the colored paint 'splat' specified to the top right of the item icon.
Attributes
item-level Level 50 Item level. Defaults to "Level 0-100".

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 6 positive, negative and neutral values.
neutral-attributes
positive-attributes
negative-attributes
(See section on examples below) These parameters are provided for backwards compatibility. The newer att-n-neutral parameters should be used instead.
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 Tradeable, Not Usable in Crafting For item flags. Displays them inside brackets: "( Not Tradeable, Not 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.

Item quality

See also: Rarity

Values of the parameter "quality" accepted by this template.

Quality Hex value
normal #B2B2B2
unusual #8650AC
vintage #476291
genuine #4D7455
unique #FFD700
customized #476291
community #70B04A
self-made #70B04A
valve #A50F79

Examples

Example usages of {{Backpack item}}.

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

The above code will generate the following:

Backpack Cloak and Dagger.png

Cloak and Dagger
Level 5 Invis Watch


{{Backpack item
| item-name = Rocket Launcher
| custom-name = Rawket Lawnchair
| quality = vintage
| prefix = The Greatest
| item-level = Level 50 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.
| width = 50%
}}

The above code will generate the following:

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."

See also

Image insertion templatesview  edit )