Template:Item infobox

From Terraria Wiki
Jump to: navigation, search

This template defines the table "Items_new". View table.

This template is i18n-ready, which means it is easy to localize for different languages. Please see I18n & l10n for Templates to learn more.
Lua logo.svg
This template uses Module:Iteminfo, a script written in the Lua programming language. Please see wikipedia:Lua and mw:Extension:Scribunto to learn more about Lua.
Template-info.svg Documentation The documentation below is transcluded from Template:Item infobox/doc. (edit | history)

This template is used for displaying the infobox for an item. It is one of the most important and most powerful infobox templates.

Usage[edit source]

While the template is extremely versatile, its main functionality is to display the standard infobox.

The data which is to be displayed can be manually entered when calling the template, but thanks to {{iteminfo}}, the vast majority of data is generated automatically. To enable automatic data, use the parameter auto and set it to the ID of the item (alternatively: auto=yes and either id=<item ID>, name=<item name>, or nothing else – the latter two methods will cause the template to automatically generate the ID using {{itemNameFromId}}, with the last method using the page title for name reference). This way, all relevant item parameters are set automatically. See the table below for affected parameters. However, they can still be overridden and manually entered parameters always take precedence over the automatic ones.

Basic parameters[edit source]

Notes:
  • The dollar sign ($) is used to signify that the word after it is the name of a template parameter.
  • All parameters which have a default value listed can usually be omitted. Note that this does not mean that parameters which do not have a default value listed should always be filled in.
Parameter Description Auto Example Default value
(if omitted)
Note
{{item infobox
Box-related parameters
| boxwidth Width of the infobox 27em 21em Number with unit. Default is 21em or stretching to image width
| float Position of the infobox left right
| css
 or
| style
CSS style affecting the entire infobox Any width or float properties defined here will override the template's $boxwidth and $float parameters, respectively.
| auto Enables automatic data 465 Can also be yes (see text above).
| id ID of the item Yes 465 The automatic data gathering for $tooltip is based on this.
| name Name of the item Yes Wood Page name Will be displayed as heading of the infobox.
| lname Localized name of the item Yes Legno
(Italian for "Wood")
{{tr|$name}} Will be displayed as heading of the infobox; only to be used if $name is not existent in the {{tr}} database of the specific language.
| namesub Name sub-heading Additional information directly underneath the title of the infobox; rarely useful for item infoboxes.
Image-related parameters
| imagealt Complete custom control over the entire image display [[File:Wood.png]] Overrides all image parameters in this parameter category.
| ext File extension of $image gif png
| image Main image of the inventory icon or equipped item/set Wood.png $name.$ext
| imageold Variant image of the older versions Compass (old).png $name (old) Default value: First checks for the .gif and then for the .png.
| imageplaced Image of the placed item Wood (placed).png $name (placed)
| imageequipped Image of the equipped item/set Shackle (equipped).png $name (equipped)
| imagefemale Image of the female equipped item/set Robe (equipped) female.png $name female.$ext
| imageoldalt Complete custom control over the "old" image display [[File:Compass (old).png]]
| imageplacedalt Complete custom control over the "placed" image display [[File:Wood (placed).png]]
| imageequippedalt Complete custom control over the "equipped" image display [[File:Shackle (equipped).png]]
| imagebreak Arranges multiple images in rows rather than in columns yes Causes the main/"old", "placed", "equipped", and "female" images to all take up a separate row, with small horizontal bars in between (example: Book). Note that the main and "old" images will always be displayed in the same row. Also note that this effect is enabled regardless of what $imagebreak is set to (i.e, setting it to no will also enable it – so refrain from doing that).
| imageinfo Prevents the internal usage of {{image}} no Setting it to no will cause the template to use the standard [[File:]] syntax instead of {{image}}. {{image}} will increase the expensive function count, so if there are many item infoboxes on one page, the expensive function count limit may be exceeded. Using imageinfo=no can reduce the count to avoid exceeding it. In the vast majority of cases, this is not necessary.
Statistics-related parameters
| autoswing Auto-use capability Yes yes Displays Autoswing, Autofire, or Auto-use in the top-right corner of the infobox. Hover text is determined by $damagetype ("Autoswing" for melee, "Autofire" for ranged and magic, and "Auto-use" for anything else).
| stack Maximum possible stack size Yes[1] 99 1 max quantity of this item that can be stacked in a single inventory slot
| pick Pickaxe power Yes 100 Without percentage sign (%)! If any of the three parameters is used, all three symbols will always be displayed: Pickaxe icon.png Hammer icon.png Axe icon.png
| hammer Hammer power Yes 75
| axe Axe power Yes 50
| pickreq Required pickaxe power for destroying No 150 Without percentage sign (%)!
| hammerreq Required hammer power for destroying No 80 Without percentage sign (%)! Prints the following behind it: "(only in Hardmode)"
| type
 (deprecated:
| type2)
Classification and categorization Yes eg. Weapon, Tool, Furniture, etc. "/" separated. e.g. Weapon / Tool. "Crafting material" will be auto added if needed.
| bait Bait power Yes Without percentage sign (%)!
| damage Damage Yes[1]
| damagetype Damage type Yes melee, ranged, magic, summon, or thrown
| knockback Knockback Yes[1] If more than one value needed, you should wrap the values with {{kb}}, e.g. {{kb|7.5}}/{{kb|6}}.
| defense Defense Yes[1]
| tileboost Tile range boost Yes
| bonus Miscellaneous bonuses No
| setbonus Set bonus No For armor sets, where $type contains Set. If possible, {{gameText}} should be used here.
| placeable Placeable Yes yes/no
| width Width when placed No In tiles.
| height Height when placed No In tiles.
| consumable Consumable Yes true: (found in source code) leaves player's inventory with Use / Attack, includes placeable items
| mana Mana cost Yes[1]
| mheal Mana restoration Yes[1]
| hheal Health restoration Yes[1]
| critical Critical strike chance Yes[1] if no value is entered and the main Type is "Weapon", a default value of 4% is displayed
| body slot Body slot No
| use Use time Yes
| velocity
 (deprecated:
| sspeed)
Velocity Yes
| toolspeed Tool speed Yes[1]
| tooltip Tooltip Yes[1]
| rare Rarity Yes[1] eg. '1' for Blue, '2' for Green, 'q' for Amber (quest), 'rainbow' for expert-exclusive.
| buy Buy value Yes[1] enter using the coin template ({{coin}}). Use buy=y/yes/true/show to enable display of buy price (disabled by default, since many items that can be sold cannot be bought).
| sell Sell value Yes[1] also enter using coin template
| value Value Yes Mostly used internally. Will not be displayed directly, but serves as the base for $buy and $sell.
Buff- & Debuff-related parameters
| bufftype Type of the status effect Yes Mostly used internally. Can be buff or debuff.
| idbuff Buff ID Yes
| buff Buff provided Yes
| bufflink Buff link target Yes
| bufftip Buff tooltip Yes
| duration Buff duration Yes[1]
| debuff Debuff inflicted No you can use shortcut: "[name] / [duration] / [chance(optional)]" for debuff/debuffduration/debuffchance.
| debufflink Debuff link target No
| debufftip Debuff tooltip No
| debuffchance Debuff chance No
| debuffduration Debuff duration No
Mount-related parameter
| idmount Mount ID Yes
Projectile-related parameters
| idprojectile
 (deprecated:
| shoot)
Projectile ID Yes Can be a comma-separated list for multiple IDs.
| projectilename Projectile name Yes
| projectileimage Projectile image Yes
| projectileblock Projectile images arrangement No Operates similarly to $imagebreak.
ID-related parameters
| showids Display of ID section No no ID section is not hidden by default.
| idshow Vanity item ID No
| idtile Tile ID Yes
| idtileshow Vanity tile ID No
| idtilesub Tile sub-ID Yes Internally known as placeStyle in Terraria.
| idwall Wall ID Yes
| idbuffshow Vanity buff ID No
Back-end-related parameters
| cate Toggles categorization No no Set to yes to force categorization when it is disabled by default (on non-mainspace pages). Set to no to disable categorization.
| listexclude Toggles categorization No yes no Set to yes to disable categorization. Overrides cate=yes, but not cate=no.
| cargo Toggles cargo data storage No no Set to force to force cargo data storage when it is disabled by default (on non-mainspace pages). Set to no to disable cargo data storage. Note that setting it to anything else (e.g. yes) also disables cargo data storage, so please stick to the unambiguous no.
| listcat Categorization Yes Supplemental category names to include the current item in a DPL list, e.g. arrows causes the item to display at the Arrows page. Separate multiple categories with a slash character (/). The following categories will be added automatically:
| tag
 or
| tags
Categorization Yes Supplemental category names to appropriately categorize the item. Can contain any of the following (separate multiple with a slash character (/):
  • buy/buyable/vendor (equal to buy=yes)
  • hardmodeonly/hardmode (equal to hardmode=yes)
  • allversions (equal to allversions=yes)
  • dd2 (means that this item is to be purchased with Defender Medal.)
  • drop (equal to listcat=drop items)
  • loot (equal to listcat=loot items)
  • plunder (equal to listcat=plunder items)
  • fished (equal to listcat=fished items)
  • unobtainable (equal to listcat=unobtainable items)
  • developer (equal to listcat=developer items).
  • storage (equal to listcat=storage items).
  • informational (equal to listcat=informational items).
  • quest rewards (equal to listcat=quest rewards).
  • light source (equal to listcat=light source items).
  • novelty (equal to listcat=novelty items).
  • mechanism (equal to listcat=mechanism items).
  • potion ingredients (equal to listcat=potion ingredients).
  • bag loot/bagloot (equal to listcat=bag loot items).
  • treasure bag loot (equal to listcat=Treasure Bag loot items).
  • minion (equal to type=weapon and listcat=minion summon items).
  • sentry (equal to type=weapon and listcat=sentry summon items).

All other values will have no effect. All tags will be stored to cargo for querying.

| allversions Platform version availability Yes Set to yes to assert that the item is available on all platforms of Terraria. This is only to be used if no {{exclusive}} banner is on the page. If omitted and if $tags does not contain allversions, it will be detected automatically based on the result of {{eversions|<item name>}} (even though $auto might not be set!). Categorizes the page in all five version content categories (with the exception of Category:Japanese console content), if yes is determined.
| hardmode Hardmode-exclusivity Yes yes Set to yes to assert that the item is not available in pre-Hardmode, but only becomes available in Hardmode. Categorizes the page in Category:Hardmode-only items.

Subpages[edit source]

There are numerous supplemental subpages which are mainly used for formatting certain data:

See also[edit source]

Footnotes[edit source]

  1. 1.00 1.01 1.02 1.03 1.04 1.05 1.06 1.07 1.08 1.09 1.10 1.11 1.12 1.13 Any occurrence of the string @@@@ in the parameter value will be replaced by the automatically generated data. This can be used to mix automatic and manual data.