Difference between revisions of "Template:User item infobox/doc"

From Team Fortress Wiki
Jump to: navigation, search
m
m
Line 74: Line 74:
 
;imagewidth: Sets the width of the image defined above. The max recommended value (set by default) is 248px.
 
;imagewidth: Sets the width of the image defined above. The max recommended value (set by default) is 248px.
  
;kill-icon-<small>n</small>: Image for the item's kill icon(s), if any, without the "File:" prefix and ".png" suffix. These fields only supports PNG files. Up to 6 kill icons can be used.
+
;kill-icon-<small>n</small>: Image for the item's kill icon(s), if any, without the "File:" prefix and ".png" suffix. These fields only supports PNG files. Up to 6 kill icons can be used. Please add them in crescent order or they won't work otherwise. (eg. do not add a "-4" without a "-3")
  
 
=== Basic information parameters ===
 
=== Basic information parameters ===

Revision as of 12:29, 8 December 2012

This infobox template can be used to display fake or personal items in user pages.

Usage

Please remove the parameters that are left blank. See Parameters section below for documentation of all parameters.

{{User item infobox
| title = 
| infoboxcolour = 
| image = 
| imagewidth = 
| kill-icon-1 = 
...
| kill-icon-6 = 

| basic-information = 
| wearable = 
| used-by = 
| slot = 
| equip-region-1 = 
| equip-region-2 = 
| contributed-by = 
| released = 
| availability = 
| trade = 
| gift = 
| craft = 
| paint = 
| rename = 
| numbered = 
| medieval = 
| taunt-kill = 

| ammo = 
| ammo-loaded = 
| ammo-carried = 
| ammo-type = 
| reload-type = 

| loadout = 
| base-item = 
| custom-name = 
| no-custom-name-quotes = 
| custom-icon = 
| quality = 
| prefix = 
| suffix = 
| paint-color = 
| no-level = 
| item-level = 
| att-1-positive = 
...
| att-8-negative = 
| item-description = 
| custom-description = 
| gift-from = 
| date-received = 
| item-expiration = 
| item-uses = 
| item-flags = 
}}

Parameters

All parameters are completely optional. As such, unused parameters should be cleared from the template.

Setup & Image parameters

title
The title displayed on the top of the infobox. If left blank, it'll show your userpage name.
infoboxcolour
Changes the infobox colour. Default is silver. It can be used as a word ("red") or hexadecimal code ("#FF0000).
image
The weapon image displayed under the title wihtout the "File:" prefix. By default, it'll display a "Screenshot needed" image.
imagewidth
Sets the width of the image defined above. The max recommended value (set by default) is 248px.
kill-icon-n
Image for the item's kill icon(s), if any, without the "File:" prefix and ".png" suffix. These fields only supports PNG files. Up to 6 kill icons can be used. Please add them in crescent order or they won't work otherwise. (eg. do not add a "-4" without a "-3")

Basic information parameters

basic-information
Setting this to no will hide the entire "Basic information" section.
wearable
Whether this item is worn (if it's a misc. item or a hat  –  yes) or not (if it's a weapon  –  no). Only accepts a yes or a no. Default is no.
used-by
The class(es) which use the item. Basic text parameter.
slot
Item slot, as if it were a weapon. Basic text parameter.
equip-region-n
The item's equip region(s), as if it were a cosmetic item. Basic text parameter.
contributed-by
Creator of the item. Basic text parameter.
released
Item's release date. Basic text parameter.
availability
How the item can be obtained. Basic text parameter.
trade
If the item can be traded. Only accepts a yes or no.
gift
If the item can be gifted. Only accepts a yes or no.
craft
If the item can be used in Crafting. Only accepts a yes or no parameter.
paint
If the item can be painted. Only accepts a yes or no parameter.
rename
If a Name Tag can be used on the item. Only accepts a yes or no parameter.
numbered
If this item has a craft number. Only accepts a yes or no parameter.
medieval
If this item can be used in Medieval mode. Only accepts a yes or no parameter.
taunt-kill
If this item has a taunt kill. Only accepts a yes or no parameter.

Ammunition parameters

ammo
Setting this to no will hide the entire "Ammunition" section.
ammo-loaded
Quantity of ammo in the weapon's clip. Basic text parameter.
ammo-loaded
Quantity of ammo available outside of the weapon's clip. Basic text parameter.
ammo-type
Type of ammo used by the weapon. Basic text parameter.
reload-type
How the ammo is reloaded into the weapon's clip. Basic text parameter.

Loadout parameters

loadout
Setting this to no will hide the entire "Loadout stats" section.
base-item
English name of the item being used as a base for the one in the template. For example, setting this to "Flare Gun" without defining the custom-name or custom-icon parameters will display the Flare Gun icon and name. Similarly, setting this parameter to "Flare Gun" while changing custom-name to "Rocket Launcher" will display the Flare Gun icon and the Rocket Launcher icon. Default is Scattergun.
custom-name
Replaces the base-item name with a custom one. Basic text parameter.
no-custom-name-quotes
Removes quotation marks from custom names. Only accepts a yes or no parameter. Default is yes. When set to no, it'll make it look like the item was renamed with a Name Tag.
custom-icon
Replaces the base-item backpack icon with a custom one. Should be used with the "File:" prefix and the extension.
quality
The item's quality. Click here for a list of all accepted values.
prefix
Setting this to none will hide the quality name. Can also be a custom value, which adds this parameter to the beginning of the item's name. Default is none.
suffix
Adds the text entered as a value at the end of the item's name. Default is none.
paint-color
Adds a paint splat on the top right corner of the item, as if it were painted. This should be a hexadecimal code of the paint's color (without the #).
item-level
Indicates the item's level and, if the user defines it, the rank and primary stat tracker on a Strange weapon. Basic text parameter. Default is "Level 0-100".
no-level
If set to yes, it'll hide the item's level.
strange-secondary
Secondary stat tracker for Strange weapons, where applicable. Basic text parameter.
att-strangerank-n
Displays up to 3 additional lines for tracking stats from Strange Parts that may have been applied to a weapon. Basic text parameter.
att-n-neutral
att-n-positive
att-n-negative
Displays up to 8 positive, negative and neutral values. Basic text parameter.
item-description
Displays a description, as it would in-game. Basic text parameter.
custom-description
Emulates a Description Tag custom description, with quotation marks surrounding it. Basic text parameter.
gift-from
Displays the source of a gifted item. Basic text parameter.
date-received
Displays the date when it was gifted, unless the gift-from parameter has a value. Basic text parameter.
item-expiration
Displays an expire text defined by the user. Basic text parameter.
item-uses
Shows how many limited uses the item has. Basic text parameter.
item-flags
Shows an item flag, for example "Not Tradable or Usable in Crafting". Basic text parameter.

See also