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

From Team Fortress Wiki
Jump to: navigation, search
m
 
(7 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
| kill-icon-6 =  
 
| kill-icon-6 =  
  
 +
| basic-information =
 +
| wearable =
 
| used-by =  
 
| used-by =  
 
| slot =  
 
| slot =  
Line 28: Line 30:
 
| numbered =  
 
| numbered =  
 
| medieval =  
 
| medieval =  
| taunt-kill =
+
| taunt-kill =  
  
 
| ammo =  
 
| ammo =  
Line 68: Line 70:
 
;infoboxcolour: Changes the infobox colour. Default is silver. It can be used as a word ("red") or hexadecimal code ("#FF0000).
 
;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.
+
;image: The weapon image displayed under the title without 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.
 
;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|kill icon(s)]], if any, without the "File:" prefix and ".png" suffix. These fields only support 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 ===
 
;basic-information: Setting this to <code>no</code> will hide the entire "Basic information" section.
 
;basic-information: Setting this to <code>no</code> will hide the entire "Basic information" section.
  
;used-by: The class(es) which use the item. Basic text parameter.
+
;wearable: Whether this item is worn (if it's a misc. item or a hat → <code>yes</code>) or not (if it's a weapon, a tool or an action item → <code>no</code>). Only accepts a <code>yes</code> or a <code>no</code> value. Default is <code>no</code>.
 +
 
 +
;used-by: The [[Classes|class]] or classes that use the item. Basic text parameter.
  
 
;slot: Item slot, as if it were a weapon. Basic text parameter.
 
;slot: Item slot, as if it were a weapon. Basic text parameter.
Line 89: Line 93:
 
;availability: How the item can be obtained. Basic text parameter.
 
;availability: How the item can be obtained. Basic text parameter.
  
;trade: If the item can be traded. Only accepts a <code>yes</code> or <code>no</code>.
+
;trade: If the item can be [[Trading|traded]]. Only accepts a <code>yes</code> or <code>no</code> value.
  
;gift: If the item can be gifted. Only accepts a <code>yes</code> or <code>no</code>.
+
;gift: If the item can be [[Gift Wrap|gifted]]. Only accepts a <code>yes</code> or <code>no</code> value.
  
;craft: If the item can be used in Crafting. Only accepts a <code>yes</code> or <code>no</code> parameter.
+
;craft: If the item can be used in [[Crafting]]. Only accepts a <code>yes</code> or <code>no</code> value.
  
;paint: If the item can be painted. Only accepts a <code>yes</code> or <code>no</code> parameter.
+
;paint: If the item can be [[Paint Can|painted]]. Only accepts a <code>yes</code> or <code>no</code> value.
  
;rename: If a Name Tag can be used on the item. Only accepts a <code>yes</code> or <code>no</code> parameter.
+
;rename: If a [[Name Tag]] can be used on the item. Only accepts a <code>yes</code> or <code>no</code> value.
  
;numbered: If this item has a craft number. Only accepts a <code>yes</code> or <code>no</code> parameter.
+
;numbered: If this item has a [[Trading|craft number]]. Only accepts a <code>yes</code> or <code>no</code> value.
  
;medieval: If this item can be used in Medieval mode. Only accepts a <code>yes</code> or <code>no</code> parameter.
+
;medieval: If this item can be used in [[Medieval mode]]. Only accepts a <code>yes</code> or <code>no</code> value.
  
;taunt-kill: If this item has a taunt kill. Only accepts a <code>yes</code> or <code>no</code> parameter.
+
;taunt-kill: If this item has a [[taunt kill]]. Only accepts a <code>yes</code> or <code>no</code> value.
  
 
=== Ammunition parameters ===
 
=== Ammunition parameters ===
Line 119: Line 123:
 
;loadout: Setting this to <code>no</code> will hide the entire "Loadout stats" section.
 
;loadout: Setting this to <code>no</code> 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 <code>custom-name</code> or <code>custom-icon</code> parameters will display the Flare Gun icon and name. Similarly, setting this parameter to "Flare Gun" while changing <code>custom-name</code> to "Rocket Launcher" will display the Flare Gun icon and the Rocket Launcher icon. Default is Scattergun.
+
;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 <code>custom-name</code> or <code>custom-icon</code> parameters will display the Flare Gun icon and name. Similarly, setting this parameter to "Flare Gun" while changing <code>custom-name</code> to "Rocket Launcher" will display the Flare Gun icon and the Rocket Launcher name.
  
 
;custom-name: Replaces the <code>base-item</code> name with a custom one. Basic text parameter.
 
;custom-name: Replaces the <code>base-item</code> name with a custom one. Basic text parameter.
  
;no-custom-name-quotes: Removes quotation marks from custom names. Only accepts a <code>yes</code> or <code>no</code> parameter. Default is <code>yes</code>. When set to <code>no</code>, it'll make it look like the item was renamed with a Name Tag.
+
;no-custom-name-quotes: Removes quotation marks from custom names. Only accepts a <code>yes</code> or <code>no</code> value. Default is <code>yes</code>. When set to <code>no</code>, it'll make it look like the item was renamed with a [[Name Tag]].
  
 
;custom-icon: Replaces the <code>base-item</code> backpack icon with a custom one. Should be used with the "File:" prefix and the extension.
 
;custom-icon: Replaces the <code>base-item</code> backpack icon with a custom one. Should be used with the "File:" prefix and the extension.
  
;quality: The item's quality. Click [[Template:Backpack item/doc#Item quality|here]] for a list of all accepted values.
+
;quality: The item's [[Item quality|quality]]. Click [[Template:Backpack item/doc#Item quality|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.
+
;prefix: Setting this to <code>none</code> 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 <code>none</code>.
  
;suffix: Adds the text entered as a value at the end 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 <code>none</code>.
  
;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 #).
+
;paint-color: Adds a paint splat on the top right corner of the item, as if it were [[Paint Can|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".
+
;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 <code>Level 0-100</code>.
  
;no-level: If set to yes, it'll hide the item's level.
+
;no-level: If set to <code>yes</code>, it'll hide the item's level.
  
 
;strange-secondary: Secondary stat tracker for Strange weapons, where applicable. Basic text parameter.
 
;strange-secondary: Secondary stat tracker for Strange weapons, where applicable. Basic text parameter.
  
;att-strangerank-<small>n</small>: Displays up to 3 additional lines for tracking stats from Strange Parts that may have been applied to a weapon. Basic text parameter.
+
;att-strangerank-<small>n</small>: Displays up to 3 additional lines for tracking stats from [[Strange Parts]] that may have been applied to a weapon. Basic text parameter.
  
 
;att-<small>n</small>-neutral
 
;att-<small>n</small>-neutral
Line 147: Line 151:
 
;att-<small>n</small>-positive
 
;att-<small>n</small>-positive
  
;att-<small>n</small>-negative: Displays up to 8 positive, negative and neutral values. Basic text parameter.
+
;att-<small>n</small>-negative: Displays up to 8 positive, negative and neutral values. Basic text parameter. See [[Template:Backpack item#Examples|these examples]] for more help.
  
 
;item-description: Displays a description, as it would in-game. 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.
+
;custom-description: Emulates a [[Description Tag]] custom description, with quotation marks surrounding it. Basic text parameter. Also replaces the item description field.
  
;gift-from: Displays the source of a gifted item. Basic text parameter.
+
;gift-from: Displays the source of a [[Gift Wrap|gifted]] item. Basic text parameter.
  
 
;date-received: Displays the date when it was gifted, unless the <code>gift-from</code> parameter has a value. Basic text parameter.
 
;date-received: Displays the date when it was gifted, unless the <code>gift-from</code> parameter has a value. Basic text parameter.
Line 161: Line 165:
 
;item-uses: Shows how many limited uses the item has. 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.
+
;item-flags: Shows an item flag, for example <code>Not Tradable or Usable in Crafting</code>. Basic text parameter.
  
 
== See also ==
 
== See also ==

Latest revision as of 18:11, 23 June 2020

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 without 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 support 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, a tool or an action item → no). Only accepts a yes or a no value. Default is no.
used-by
The class or classes that 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 value.
gift
If the item can be gifted. Only accepts a yes or no value.
craft
If the item can be used in Crafting. Only accepts a yes or no value.
paint
If the item can be painted. Only accepts a yes or no value.
rename
If a Name Tag can be used on the item. Only accepts a yes or no value.
numbered
If this item has a craft number. Only accepts a yes or no value.
medieval
If this item can be used in Medieval mode. Only accepts a yes or no value.
taunt-kill
If this item has a taunt kill. Only accepts a yes or no value.

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 name.
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 value. 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. See these examples for more help.
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. Also replaces the item description field.
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