View source for Template:Backpack item/doc

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

== Parameters ==
{| class="wikitable grid"
! width="15%" class="header" | Parameter
! width="35%" class="header" | Example
! class="header" | Description
|-
| {{code|item-name}}
| {{code|Batter's Helmet}}
| 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.
|-
| {{code|custom-name}}
| {{code|Spam Hammer}}
| Adds a custom name with quotation marks. Still needs {{code|item-name}} to produce the correct image.
|-
| {{code|custom-icon}}
| {{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.
|-
| {{code|quality}}
| {{code|normal}}
| Defaults to "{{code|unique}}" (the standard item yellow). See [[#Item quality|all accepted values]] in the list below.
|-
| {{code|prefix}}
| {{code|none}}<br />{{code|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. "{{code|1=prefix = The Best}}" will generate "The Best Flare Gun".
|-
| {{code|paint-color}}
| {{code|7C6C57}}
| Adds the colored paint 'splat' specified to the top right of the item icon.
|-
! style="text-align:left;" class="header" colspan="3" | ''Attributes''
|-
| {{code|item-level}}
| {{code|Level 50}}
| Item level. Defaults to "<span class="att_level">Level 0-100</span>".
|-
|  
<code>att-<sub>n</sub>-neutral</code><br />
<code>att-<sub>n</sub>-positive</code><br />
<code>att-<sub>n</sub>-negative</code>
| 
<code>att-1-neutral = Cloak Type: Feign Death</code><br />
<code>att-2-positive = +80% cloak regen rate</code><br />
<code>att-3-negative = +60% cloak drain rate</code><br />
(See section on [[#Examples|examples]] below)
| Displays up to 8 positive, negative and neutral values.
|-
| style="font-size:90%;" | {{code|neutral-attributes}}<br />{{code|positive-attributes}}<br />{{code|negative-attributes}}
| (See section on [[#Examples|examples]] below)
| These parameters are provided for backwards compatibility. The newer <code>att-<sub>n</sub>-neutral</code> parameters should be used instead.
|-
| {{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.}}
| 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|Robin}}
| Display the source of a gifted item. Displays the text "<span class="att_positive">Gift from: Robin</span>"
|-
| {{code|date-received}}
| {{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. Displays the text "<span class="att_neutral">Date Received: Mar 23, 2011 (06:30:00)</span>"
|-
| {{code|item-expiration}}
| {{code|Dec 31, 2010 (23:00:00)}}
| 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 Tradeable, Not Usable in Crafting}}
| For item flags. Displays them inside brackets: "<span class="att_flags">( Not Tradeable, Not 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.
|-
|}

=== Item quality ===
{{see also|Rarity}}

Values of the parameter "{{code|quality}}" accepted by this template.

{| class="wikitable grid"
! Quality
! Hex value
|-
| style="background:#B2B2B2;" | normal || #B2B2B2
|-
| style="background:#8650AC;" | unusual || #8650AC
|-
| style="background:#8650AC;" | haunted || #8650AC
|-
| style="background:#476291;" | vintage || #476291
|-
| style="background:#4D7455;" | genuine || #4D7455
|-
| style="background:#FFD700;" | unique || #FFD700
|-
| style="background:#476291;" | customized || #476291
|-
| style="background:#70B04A;" | community || #70B04A
|-
| style="background:#70B04A;" | self-made || #70B04A
|-
| style="background:#A50F79;" | valve || #A50F79
|-
| style="background:#CF6A32;" | strange || #CF6A32
|-
|}

== Examples ==
Example usages of {{tl|Backpack item}}.

<pre><nowiki>
{{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%
}}
</nowiki></pre>

The above code will generate the following:
{{Backpack item
| item-name = Cloak and Dagger
| item-level = Level 5 Invis Watch
| neutral-attributes = Cloak Type: Feign Death
| positive-attributes = +80% cloak regen rate
| negative-attributes = +60% cloak drain rate
| width = 25%
}}

<hr style="margin:2em 0em;" />

<pre><nowiki>
{{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%
}}
</nowiki></pre>

The above code will generate the following:

{{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%
}}

== See also ==
{{Image insertion templates list}}

<noinclude>[[Category:Template documentation|Backpack item]]</noinclude>