Template:Item

This template uses Module:Item, a script written in the Lua programming language. To learn more about Lua, see Terraria Wiki:Lua.

This template is i18n-ready, which means it is easy to localize for different languages. Please see I18n & l10n for templates to learn more.

This template uses Extension:Cargo, an integral part of the wiki's back-end.

This template adds rows to the table "Imageinfo", which is declared by the template Image. View table.

Documentation The documentation below is transcluded from Template:Item/doc. (edit | history)

[purge]

An all-in-one template for display item name/icon/link.

By default, displays a link to the item and adds an item icon in front of it.

Usage

All parameters are optional. Despite this, some combinations are invalid and may cause errors, e.g. {{item|icons=no|mode=image}}

See examples below for more details.

unnamed parameter 1

Default item display name, link target, and image file name. If unspecified, will try to retrieve it from {{{id}}}.

unnamed Parameter 2

Custom link text, which can include line breaks (<br />) and other wikitext. If an 's', 'es', 'ies' or 'ves' is passed as the custom text, it will be appended to the end of the item name. Pluralism is partially intuitive - adding 's' to Butterfly will return Butterflies. For non-english language, auto translation will be applied.

t

Custom link text, it will override unnamed Parameter 2, and it will be displayed as-is, without plural processing and auto translation.

mode

Display mode. It can be:

image(Preferred) or imageonly or onlyimage means only image will be displayed;
text(Preferred) or noimage means no image will be displayed;
table(Preferred) or 2-cell will output 2 cells code for table. This is roughly a shortcut for {{item|mode=image|itemname}} || {{item|mode=text|itemname}}

Use preferred values as much as possible to get the best performance.

image

image filename, no brackets nor "File:"(must include file extension, eg. Parrot.png).

You can specify multiple images, just separate filenames with slashes(eg. Parrot.png/Parrot (placed).png).

size

Custom graphic size (Read Extended image syntax for details).

You can specify multiple sizes, just separated with slashes(eg. 32px/24x24px).

When multiple images specified:

- If only one size specified, it will apply to all images
- if size is less than image, extra images will be displayed as if they don't have size argument
- if size is more than image, extra sizes will simply be ignored.

And you can append it with *[factor] to scale image, e.g. 24x24px*0.5, 24px*0.5/24px*2 ...

scale

maxsize

Image size limit. Using standard image size syntax, eg. 32px/24x24px. will be applied after scale.

ext

image file extension, default is png. Only valid when there is no image input.

link

Custom link target. If blank given(i.e. |link=|), it will be no link(See example below). Note: eicons also will base on link first. If you use |link=somelink|nolink=y, it will be ignored.

nolink = y/yes

Same as |link=|. Overrides any link input.

anchor = y/yes

If set, will create an anchor for {{{1}}}.

note

Extra note text. By default, it will be displayed as smaller and gray text between item name and platform icons , and without link on it.

note2

Another note text. By default, it will be displayed as gray txt in normal size, without link, and always take a single line.

bignote

Another note text. It will always be displayed after all other text block.

wrap = y/yes

Only valid when there is no id= or note2= input. If set, platform icons and/or note will be displayed in new line.

icons = n/no/y/yes/<icons content>

n/no=suppresses the platform icons; default is yes; other values will completely override platform icons part, in this case, the value of this parameter should/must usually be {{eicons|...}}, see examples below.

small = y/yes

Reduces the size of the platform icons (useful when space is an issue).

id

Number, will display items(or other type) ID information.

type

the type of ID, case-insensitive, default is item, only valid when id is specified. can be tile, wall, npc, mount, buff, debuff, projectile, or armor. All other values are treated as item.

showid = y/yes/n/no

Explicitly turn on/off id display. Default is on when id is set, off when id is not set. If showid is turned on and id is not set, will auto retrieve id from database (using data templates such as {{itemIdFromName}}, according to value of type).

class

Custom Css class(es). There're some predefined classes for certain formatting purpose(see examples below). You can add yours if needed.

css or style

Custom css style rules.

Examples

Basic

Result	Code	Note
Bed	`{{item\|Bed}}`	Basic usage.
Format:C(Desktop, Console and Mobile versions)	`{{item\|Format:C}}`	":" in item name.
Weapon Imbue: Venom	`{{item\|Weapon Imbue: Venom}}`	": " in item name.
Any Bed	`{{item\|Bed\|Any Bed}}`	Custom text.
Any Bed	`{{item\|Bed\|Any [[Beds\|Bed]]}}`	Custom text with link. Note the difference between link target of image and link target of text.
Psycho Knives(Desktop, Console and Mobile versions) Butterflies	`{{item\|Psycho Knife\|s}} {{item\|Butterfly\|s}}`	plural.
Wooden SwordInternal Item ID: 24	`{{item\|id=24}}`	auto retrieve name from id.
Wooden Sword	`{{item\|id=24\|showid=no}}`	auto retrieve name from id but don't display id.
My Best WeaponInternal Item ID: 24	`{{item\|id=24\|t=My Best Weapon}}`	auto retrieve name from id.
ConfusedInternal Buff ID: 31	`{{item\|id=31\|type=buff}}`	auto retrieve buff name from id.
Wall of Flesh	`{{item\|Wall of Flesh\|size=32px}}`	custom image size. (Read Extended image syntax for details).
Wall of Flesh	`{{item\|Wall of Flesh\|size=32px\|Wall of<br/>Flesh}}`	Custom text in multiple lines.
Wall of Flesh	`{{item\|Wall of Flesh\|size=32px\|Wall of<br/>Flesh\|class=multi-line}}`	Multiple lines need "multi-line" class for middle vertical align.
Treasure Bags(Desktop, Console and Mobile versions)	`{{item\|Treasure Bag\|s\|ext=gif}}`	Custom image file extension.
Treasure Bags(Expert Mode)(Desktop, Console and Mobile versions)	`{{item\|Treasure Bag\|s\|note={{small\|(Expert Mode)}}\|ext=gif}}`	Note text.
Parrot Pet	`{{item\|Pet Parrot\|image=Parrot.png\|Parrot Pet}}`	Custom image file name.
Parrot Pet	`{{item\|Pet Parrot\|image=Parrot.png\|Parrot Pet\|ext=jpg}}`	Will display Parrot.png, `ext` is ignored when `image` specified.
× Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|image=<div style="background:yellow">[[File:Guide.png]]×[[File:Nurse.png]]</div>}}`	Custom image code. The code must include at least one `[[File:` (case insenstive).
Parrot Pet	`{{item\|Parrot\|link=Pet Parrot\|Parrot Pet}}`	Custom link target.
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|link=}}`	Unlinked.
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|nolink=y}}`	Unlinked.
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|nolink=y\|link=Bee}}`	if `nolink=y` is specified, it will override `link`.
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|small=y}}`	Small platform icons.
Beeswax	`{{item\|Beeswax\|icons=no}}`	Don't display platform icons.(Will be faster)
Beeswax(Old-gen console and 3DS versions)Internal Item ID: 5019	`{{item\|Beeswax\|id=5019}}`	With Item ID infomation
Wooden SwordInternal Item ID: 24	`{{item\|Wooden Sword\|showid=y}}`	Auto Item ID.(only works for PC items)
Pet Tiphia(Old-gen console and 3DS versions)Internal Buff ID: 204	`{{item\|Pet Tiphia\|id=204\|type=buff}}`	Other type of ID, in this case, Buff ID.
GuideInternal NPC ID: 22	`{{item\|Guide\|id=22\|type=npc}}`	NPC ID.
ConfusedInternal Buff ID: 31	`{{item\|Confused\|showid=y\|type=buff}}`	Auto Buff ID
Beeswax(Old-gen console and 3DS versions)Internal Item ID: 5019	`{{item\|Beeswax\|id=5019\|anchor=y}}`	Create an anchor. Now {{PAGENAME}}#Beeswax will link to here.

Size and scale

Result	Code	Note
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax}}`	Default size, this image is 32px in height.
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|size=16px}}`	Custom absolute size.(x16px)
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|size=*0.5}}`	Custom scaled size.(x16px)
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|size=x40px*0.5}}`	Scaled absolute size.(x20px)
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|scale=0.5}}`	Scale. (x16px)
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|size=40px*0.5\|scale=2}}`	combine scaled size and scale. (40px)
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|maxsize=12px}}`	maxsize
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|maxsize=40px}}`	maxsize, no effect
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|maxsize=12x16px}}`	maxsize
Beeswax(Old-gen console and 3DS versions)	`{{options/set\|item\|scale=0.5}}{{item\|Beeswax}}{{options/reset\|item}}`	change scale via option.
Beeswax(Old-gen console and 3DS versions)	`{{options/set\|item\|scale=0.55}}{{item\|Beeswax\|size=*0.5}}{{options/reset\|item}}`	double scale.

Note: Due to the way of [[File:]]'s size option works, if you want to set a size (after scale) larger than origin image size, you need to set it in DDpx or DDxDDpx, and xDDpx will be no effect. e.g. for Beeswax, {{item|Beeswax|size=x40px}} will be no effect.

Multiple images

Result	Code	Note
Furnace	`{{item\|Furnace\|image=Furnace.png/Furnace_(placed).gif}}`	Multiple images with auto size.
Furnace	`{{item\|Furnace\|image=Furnace.png/Furnace_(placed).gif\|size=20px}}`	Only one size specified, all images will use this size.
Furnace	`{{item\|Furnace\|image=Furnace.png/Furnace_(placed).gif\|size=30px/20px}}`	Multiple images with multiple sizes.
Furnace	`{{item\|Furnace\|image=Furnace.png/Furnace_(placed).gif\|size=30px/20px/300px}}`	Size is more than images, extra size is ignored.
Furnace	`{{item\|Furnace\|image=Furnace.png/Furnace_(placed).gif/Hellforge.png\|size=16px/50px}}`	Size is less than image, extra image will use auto size.

Platform icons

Result	Code	Note
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax}}`	Default behavior, generate platform icons from unnamed parameter 1.
Beeswax	`{{item\|Beeswax\|icons=no}}`	Don't display platform icons.
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|epage=Bee Minecart}}`	Use Bee Minecart to generate platform icons.
Beeswax(Desktop, Console, Mobile and 3DS versions)	`{{item\|Beeswax\|icons= {{eicons\|1.4.0.1\|3ds=y\|small=y}} }}`	Override platform icons.
Beeswax(Desktop, Console, Mobile and 3DS versions)	`{{item\|Beeswax\| small=y \| icons= {{eicons\|1.4.0.1\|3ds=y}} }}`	Size setting of {{item}} will override size setting of {{eicons}} in {{{icons}}} input.
Beeswax(Desktop, Console, Mobile and 3DS versions)	`{{item\|Beeswax\|icons= {{eicons\|1.4.0.1\|3ds=y\|small=y}} }}`

Wrap, id, note, note2 and bignote

wrap is valid only when id and note2 are not specified.

Result	Code	Note
Beeswax(Old-gen console and 3DS versions)	`{{item\|Beeswax\|wrap=y}}`	If there are platform icons and no note, platform icons will wrap to next line. note that platform icons are displayed in reduced size.
bed(some note)	`{{item\|bed\|wrap=y\|note=(some note)}}`	If there are some note, note will wrap next line.
Beeswax(Old-gen console and 3DS versions)(some note)	`{{item\|Beeswax\|wrap=y\|note=(some note)}}`	If there are some note, note will display in next line, and platform icons will display in same line.
Beeswax(some note)(Old-gen console and 3DS versions)Internal Item ID: 234	`{{item\|Beeswax\|wrap=y\|note=(some note)\|id=234}}`	If `id` is specified, note and eicons will displayed in same line, even if `wrap=y`.
Beeswax(Old-gen console and 3DS versions)some other notes.	`{{item\|Beeswax\|wrap=y\|note2=some other notes.}}`	`note2` is similar.
Beeswax(Old-gen console and 3DS versions)some other notes.Internal Item ID: 2384	`{{item\|Beeswax\|id=2384\|note2=some other notes.}}`	`id` and `note2` will always take a single line.
Beeswax(Old-gen console and 3DS versions)(BIG note) Beeswax(Old-gen console and 3DS versions)(some note)(bignote)	`{{item\|Beeswax\|\|bignote=(BIG note)}} {{item\|Beeswax\|wrap=y\|note=(some note)}}\|bignote=(bignote)`	Bignote will always be displayed after all other contents.

Display mode

Result Code Note

Beeswax(Old-gen console and 3DS versions)Internal Item ID: 2384 {{item|Beeswax|id=2384}} By default, it will display image and text info.

Beeswax(Old-gen console and 3DS versions)Internal Item ID: 2384 {{options/set|item|mode=table}}{{item|Beeswax|mode=|id=2384}}{{options/set|item|mode=}} Force to use default mode .

{{item|Beeswax|mode=image|id=2384}} mode=image: Only image will be displayed, no text, no note, no id, and no platform icons.

Beeswax(Old-gen console and 3DS versions)(some note) {{item|Beeswax|mode=text|wrap=y|note=(some note)}} mode=text: image won't be displayed.

	Beeswax(Old-gen console and 3DS versions)
	Butterflies(some note)

{| class="terraria lined"
|{{item|Beeswax|mode=table}}
|-
|{{item|Butterfly|ies|note=(some note)|mode=table}}
|}

mode=table: output as two adjacent cells for table.

	Beeswax(Old-gen console and 3DS versions)	text
	Butterflies(some note)	row 1
	Butterflies(some note)	row 2

{| class="terraria lined"
|{{item|Beeswax|mode=table}} || text
|-
|{{item|Butterfly|ies|note=(some note)|mode=table|rowspan=2}} || row 1
|-
| row 2
|}

mode=table: rowspan

	Beeswax(Old-gen console and 3DS versions)
	Butterflies(some note)

{| class="terraria lined item-noborder"
|{{item|Beeswax|mode=table}}
|-
|{{item|Butterfly|ies|note=(some note)|mode=table}}
|}

table with "item-noborder" class: hide border between 2 cells.

Css and predefined classes

Result	Code	Note
Beeswax(Old-gen console and 3DS versions)Internal Item ID: 2384	`{{item\|Beeswax\|link=\|id=2384\|css=color:red;border: 2px solid blue;padding: 3px; background:#ccc}}`	Custom css rules.
Beeswax(Old-gen console and 3DS versions)Internal Item ID: 2384	`{{item\|Beeswax\|id=2384\|class=boldname}}`	Predefined class: `boldname`, item name will displayed in bold.
Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384 Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384 Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384	`{{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=notecolor}} {{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=note2color}} {{item\|Beeswax\|id=2384\|note=note\|note2=note2\|css=color:red\|class=note2color}}`	Predefined class: `notecolor` and `note2color`, note or note2 will display in normal(inherited) text color， respectively .
Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384 Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384	`{{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=notecolor}} {{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=note2color}}`	Predefined class: `notesize` and `note2size`, note will display in normal size, or note2 will display in reduced size, respectively.
Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384 Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384 Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384	`{{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=textleft}}<br/>{{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=textcenter}}<br/>{{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=textright}}`	Predefined class: `textleft`, `textcenter`， and `textright`, Similar to `alignleft/aligncenter/alignright`, but only applied to text part.alignleft/center/right can use with text/align/center/right at same time.
Beeswax(Old-gen console and 3DS versions)Internal Item ID: 2384	`{{item\|Beeswax\|id=2384\|class=block\|mode=text}}`	Predefined class: `block`, main item element and text element will display as `block` element(default is `inline-block`). It is usually only practical when `mode=text`.
Beeswaxnote(Old-gen console and 3DS versions)note2Internal Item ID: 2384	`{{item\|Beeswax\|id=2384\|note=note\|note2=note2\|class=notesize notecolor boldname\|css=color:red}}`	You can specify multiple classes, seperate with space, and can specify custom css rules at the same time.
Wall of Flesh	`<div style="width: 5em">{{item\|Wall of Flesh\|size=32px\|class=break}}</div>`	Wrap item name for long text when there is no enough space.

Transform

You can transform item image via these CSS classes.

The transformation happens at the center of the image and its effective dimensions will retain the original values of the object as if untransformed. So be careful with rotate90 and rotate270.

Result	Code
guide	`{{item\|guide}}`
guide	`{{item\|guide\|class=mirror}}`
guide	`{{item\|guide\|class=flip}}`
guide	`{{item\|guide\|class=rotate90}}`
guide	`{{item\|guide\|class=rotate180}}`
guide	`{{item\|guide\|class=rotate270}}`

Change default options

This template supports options through {{options}} template. All valid options are listed below, see {{options}} for usage and other infomation.

See Template:item/initOptions for the initial options setting of this template.

Name	Alias	Initial Value	Value Mapping^[1]	Note
`small`	`smallicons`	`(empty)`	`yes` → `y` `on` → `y` `n` → `(empty)` `no` → `(empty)` `off` → `(empty)`
`icons`		`(empty)`	`y` → `(empty)` `yes` → `(empty)` `on` → `(empty)` `no` → `n` `off` → `n`
`anchor`		`(empty)`	`yes` → `y` `on` → `y` `n` → `(empty)` `no` → `(empty)` `off` → `(empty)`
`mode`		`(empty)`
`type`		`(empty)`
`wrap`		`(empty)`	`yes` → `y` `on` → `y` `n` → `(empty)` `no` → `(empty)` `off` → `(empty)`
`nolink`		`(empty)`	`yes` → `y` `on` → `y` `n` → `(empty)` `no` → `(empty)` `off` → `(empty)`
`class`		`(empty)`
`css`	`style`	`(empty)`
`scale`		`(empty)`
`maxsize`		`(empty)`
`showid`		`(empty)`	`yes` → `y` `on` → `y` `no` → `n` `off` → `n`	No default value, will be auto detected by other parameters.

↑ Values with mapping will be stored and loaded as mapped value. Other values without mapping will be stored and loaded as-is.

NOTE: In order to avoid unwanted influences, it is very important to restore options state as soon as possible, especially in the template. Use {{options/snap}} and {{options/restore}}

See examples below for more details.

Example

Code

output

By default: 

{{item|Beeswax|note=(note)}}

turn off platform icons: 
{{options/set|item|icons=no}}
{{item|Beeswax|note=(note)}}

turn on platform icons, and turn on small icons:
{{options/set|item|icons=y|smallicons=y}}
{{item|Beeswax|note=(note)}}

turn on line wrap, and set to text mode: 
{{options/set|item|wrap=y|mode=text}}
{{item|Beeswax|note=(note)}}

turn on no link mode: 
{{options/set|item|nolink=y}}
{{item|Beeswax|note=(note)}}

get current setting:

nolink = {{options|item|nolink}} ; 
wrap = {{options|item|wrap}} ;
mode = {{options|item|mode}} ;

reset all options: 
{{options/reset|item}}
{{item|Beeswax|note=(note)}}

custom css and class:
{{options/set|item|css=border:1px solid red;padding:3px}}
{{item|Beeswax|note=(note)}}
{{options/set|item|class=boldname}}
{{item|Beeswax|note=(note)}}

reset all:
{{options/reset|item}}
{{item|Beeswax|note=(note)}}

By default:

Beeswax(note)(Old-gen console and 3DS versions)

turn off platform icons:

Beeswax(note)

turn on platform icons, and turn on small icons:

Beeswax(note)(Old-gen console and 3DS versions)

turn on line wrap, and set to text mode:

Beeswax(Old-gen console and 3DS versions)(note)

turn on no link mode:

Beeswax(Old-gen console and 3DS versions)(note)

get current setting:

nolink = y ; wrap = y ; mode = text ;

reset all options:

Beeswax(note)(Old-gen console and 3DS versions)

custom css and class:

Beeswax(note)(Old-gen console and 3DS versions)

reset all:

Beeswax(note)(Old-gen console and 3DS versions)

About Translation

{{item}} is i18n-ready and integrated automatic translation. When translate to other language, It may not require any edit, auto translation will get things done, for example:

Code	On English Page	On Italian Page
`{{item\|Golden Chest}}`	Golden Chest(Desktop, Console and Mobile versions)	Cassa dorata(Desktop, Console and Mobile versions)

if there is still English text, or you want to modify display text, please keep unnamed parameter 1 untouched({{item}} will handle the image and link target), and change unnamed parameter 2, for example:

On English Page	On Italian Page	Wrong usage
`{{item\|Copper Ore\|Ore}}`: Ore (links to Copper Ore)	`{{item\|Copper Ore\|Minerale}}`: Minerale (links to Copper Ore/it)	`{{item\|Minerale di rame}}`: Minerale di rame `{{item\|Minerale di rame\|Minerale}}`: Minerale (image and link are broken.)

[1] Values with mapping will be stored and loaded as mapped value. Other values without mapping will be stored and loaded as-is.

[1]

Personal tools

Navigation menu

Namespaces

Views

Navigation

Guides

Portals

Tools

Other languages

Template:Item

Contents

Usage

Examples

Basic

Size and scale

Multiple images

Platform icons

Wrap, id, note, note2 and bignote

Display mode

Css and predefined classes

Transform

Change default options

Example

About Translation

Navigation menu

Search

Template:Item

Usage

Examples

Basic

Size and scale

Multiple images

Platform icons

Wrap, id, note, note2 and bignote

Display mode

Css and predefined classes

Transform

Change default options

Example

About Translation