Template:Item

From Terraria Wiki
(Redirected from Template:Item link)
Jump to: navigation, search
Lua logo.svg
This template uses Module:Item, a script written in the Lua programming language. Please see wikipedia:Lua and mw:Extension:Scribunto to learn more about 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.

Ce modèle ajoute des lignes dans le tableau « Imageinfo », qui est déclaré par le modèle Image. Voir le tableau.

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

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 unspecitied, 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 tranlation 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 tranlation.

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 seperate 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 seperated with slashes(eg. 32px/24x24px).

When multiple images specified:

    • If only one size specified, it will apply to all images
    • if size is less then image, extra images will be displayed as if they don't have size argument
    • if size is more then 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

Image(s) will be scaled based on size and scale. e.g. |size=32x32px|scale=0.5 is equal to |size=16x16px. This will multiply with scale factor in size paramter, |size=32x32px*0.5|scale=0.5 is equal to |size=8x8px. scale can be set by options.

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.

nolink = y/yes

Same as |link=|, only valid when there is no link input. If you use |link=somelink|nolink=y, it will be ignored.

anchor = y/yes

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

note

Extra note text. By default, it will 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 displayed as gray txt in normal size, without link, and always take a single line.

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

n/no=suppresses the platform icons; default is yes.

id

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

type

the type of ID, case-insensitive, default is item, only valid when id is sepcified. 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).

small = y/yes

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

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
BedBed {{item|Bed}} Basic usage.
Format:CFormat:CDesktop VersionConsole VersionMobile Version {{item|Format:C}} ":" in item name.
Weapon Imbue: VenomWeapon Imbue: Venom {{item|Weapon Imbue: Venom}} ": " in item name.
Any BedAny Bed {{item|Bed|Any Bed}} Custom text.
Psycho KnivesPsycho KnivesDesktop VersionConsole VersionMobile Version ButterfliesButterflies {{item|Psycho Knife|s}} {{item|Butterfly|s}} plural.
Wooden SwordWooden Sword
Internal Item ID: 24
{{item|id=24}} auto retrieve name from id.
Wooden SwordWooden Sword {{item|id=24|showid=no}} auto retrieve name from id but don't display id.
My Best WeaponMy Best Weapon
Internal Item ID: 24
{{item|id=24|t=My Best Weapon}} auto retrieve name from id.
ConfusedConfused
Internal Buff ID: 31
{{item|id=31|type=buff}} auto retrieve buff name from id.
Wall of FleshWall of Flesh {{item|Wall of Flesh|size=32px}} custom image size. (Read Extended image syntax for details).
Wall ofFleshWall of
Flesh
{{item|Wall of Flesh|size=32px|Wall of<br/>Flesh}} Custom text in multiple lines.
Wall ofFleshWall 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 BagsTreasure BagsDesktop VersionConsole VersionMobile Version {{item|Treasure Bag|s|ext=gif}} Custom image file extension.
Treasure BagsTreasure Bags(Expert Mode)Desktop VersionConsole VersionMobile Version {{item|Treasure Bag|s|note={{small|(Expert Mode)}}|ext=gif}} Note text.
Parrot PetParrot Pet {{item|Pet Parrot|image=Parrot.png|Parrot Pet}} Custom image file name.
Parrot PetParrot Pet {{item|Pet Parrot|image=Parrot.png|Parrot Pet|ext=jpg}} Will display Parrot.png, ext is ignored when image specified.
Parrot PetParrot Pet {{item|Parrot|link=Pet Parrot|Parrot Pet}} Custom link target.
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|link=}} Unlinked.
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|nolink=y}} Unlinked.
BeeswaxBeeswax {{item|Beeswax|nolink=y|link=Bee}} if link is specified, it will override unlink=y.
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|small=y}} Small platform icons.
BeeswaxBeeswax {{item|Beeswax|icons=no}} Don't display platform icons.(Will be faster)
BeeswaxBeeswaxOld-gen console version3DS Version
Internal Item ID: 5019
{{item|Beeswax|id=5019}} With Item ID infomation
BeeswaxBeeswaxOld-gen console version3DS Version
Internal Item ID:
{{item|Beeswax|showid=y}} Auto Item ID.
Pet TiphiaPet TiphiaOld-gen console version3DS Version
Internal Buff ID: 204
{{item|Pet Tiphia|id=204|type=buff}} Other type of ID, in this case, Buff ID.
GuideGuide
Internal NPC ID: 22
{{item|Guide|id=22|type=npc}} NPC ID.
ConfusedConfused
Internal Buff ID: 31
{{item|Confused|showid=y|type=buff}} Auto Buff ID
BeeswaxBeeswaxOld-gen console version3DS Version
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
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax}} Default size, this image is 32px in height.
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|size=16px}} Custom absolute size.(x16px)
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|size=*0.5}} Custom scaled size.(x16px)
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|size=x40px*0.5}} scaled absoulte size.(x20px)
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|scale=0.5}} scale. (x16px)
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|size=40px*0.5|scale=2}} combine scaled size and scale. (40px)
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|maxsize=12px}} maxsize
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|maxsize=40px}} maxsize, no effct
BeeswaxBeeswaxOld-gen console version3DS Version {{item|Beeswax|maxsize=12x16px}} maxsize
BeeswaxBeeswaxOld-gen console version3DS Version {{item/options|scale=0.5}}{{item|Beeswax}}{{item/options|reset}} change scale via option.
BeeswaxBeeswaxOld-gen console version3DS Version {{item/options|scale=0.55}}{{item|Beeswax|size=*0.5}}{{item/options|reset}} double scale.

Note: Due to the way of [[File:]]'s size option works, if you want to set a size(after scale) larger then 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
FurnaceFurnaceFurnace {{item|Furnace|image=Furnace.png/Furnace_(placed).gif}} Multiple images with auto size.
FurnaceFurnaceFurnace {{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=20px}} Only one size specified, all images will use this size.
FurnaceFurnaceFurnace {{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=30px/20px}} Multiple images with multiple sizes.
FurnaceFurnaceFurnace {{item|Furnace|image=Furnace.png/Furnace_(placed).gif|size=30px/20px/300px}} Size is more them images, extra size is ignored.
FurnaceFurnaceFurnaceFurnace {{item|Furnace|image=Furnace.png/Furnace_(placed).gif/Hellforge.png|size=16px/50px}} Size is less then image, extra image will use auto size.

Wrap, id and note2

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

Result Code Note
BeeswaxBeeswaxOld-gen console version3DS Version {{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.
bedbed(some note) {{item|bed|wrap=y|note=(some note)}} If there are some note, note will wrap next line.
BeeswaxBeeswaxOld-gen console version3DS Version(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.
BeeswaxBeeswax(some note)Old-gen console version3DS Version
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.
BeeswaxBeeswaxOld-gen console version3DS Version
some other notes.
{{item|Beeswax|wrap=y|note2=some other notes.}} note2 is similar.
BeeswaxBeeswaxOld-gen console version3DS Version
some other notes.
Internal Item ID: 2384
{{item|Beeswax|id=2384|note2=some other notes.}} id and note2 will always take a single line.

Display mode

Result Code Note
BeeswaxBeeswaxOld-gen console version3DS Version
Internal Item ID: 2384
{{item|Beeswax|id=2384}} By default, it will display image and text info.
Beeswax {{item|Beeswax|mode=image|id=2384}} mode=image: Only image will be displayed, no text, no note, no id, and no platform icons.
BeeswaxOld-gen console version3DS Version(some note) {{item|Beeswax|mode=text|wrap=y|note=(some note)}} mode=text: image won't be displayed.
Beeswax BeeswaxOld-gen console version3DS Version
Butterflies Butterflies(some note)
{| class="wikitable"
|{{item|Beeswax|mode=table}}
|-
|{{item|Butterfly|ies|note=(some note)|mode=table}}
|}
mode=table: output as two adjacent cells for table.

Css and predefined classes

Result Code Note
BeeswaxBeeswaxOld-gen console version3DS Version
Internal Item ID: 2384
{{item|Beeswax|link=|id=2384|css=color:red;border: 2px solid blue;padding: 3px; background:#ccc}} Custom css rules.
BeeswaxBeeswaxOld-gen console version3DS Version
Internal Item ID: 2384
{{item|Beeswax|id=2384|class=boldname}} Predefined class: boldname, item name will displayed in bold.
BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal Item ID: 2384

BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal Item ID: 2384

BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal 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 .
BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal Item ID: 2384

BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal 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.
BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal Item ID: 2384

BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal Item ID: 2384

BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal 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.
BeeswaxOld-gen console version3DS Version
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.
BeeswaxBeeswaxnoteOld-gen console version3DS Version
note2
Internal 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.

Change default options

You can use {{item/options}} to set/get and reset some options' default value.

Usage

  • Set: {{item/options|nolink=y|smallicons=no|...}} or {{item/options|set|nolink=y|smallicons=no|...}}
  • get: {{item/options|get|nolink}}
  • reset: {{item/options|reset}} or {{item/options|resetall}}
NOTE: In order to avoid unwanted influences, it is very important to reset options as soon as possible. Especially in the template, you should reset options before the template ends.

All parameters:

unnamed parameter 1

Action. get or load means get the current value of a option, reset or resetall means reset all options to default value, other values(include none. if you want, recommend to use set for better readability) means set options' value.

unnamed Parameter 2

The name of option which you want to get its value, only valid when action is get. Can be small, smallicons, icons, mode, wrap, nolink, class, css or style.

small/smallicons = y/yes/n/no

Only valid when action is set. Turn on/off reduced size for platform icons. See {{item}}'s small parameter.

icons = y/yes/n/no

Only valid when action is set. Turn on/off platform icons display. When turn off, {{item}} will be faster. See {{item}}'s icons parameter.

mode

Only valid when action is set. Set the default value for {{item}}'s mode parameter. You can use any valid value for {{item}}'s mode parameter, and a invalid value(recommend to use default, all, or both for better readability) means change the mode back to default. See {{item}}'s mode parameter.

wrap = y/yes/n/no

Only valid when action is set. Turn on/off line wrap. See {{item}}'s wrap parameter.

anchor = y/yes/n/no

Only valid when action is set. Turn on/off anchor. See {{item}}'s anchor parameter.

nolink = y/yes/n/no

Only valid when action is set. Turn on/off no link option. See {{item}}'s nolink parameter.

class

Only valid when action is set. Default value for class. See {{item}}'s class parameter.

css/style

Only valid when action is set. Default value for css. See {{item}}'s css parameter.

maxsize

Only valid when action is set. Default value for maxsize. See {{item}}'s maxsize parameter.

showid

Only valid when action is set. Default value for showid. See {{item}}'s showid parameter.

See examples below for more details.

Example

Code output
By default: 

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

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

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

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

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

This will be overrided by '''<code>link=</code>'''

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

get current setting:

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

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

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

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

By default:

BeeswaxBeeswax(note)Old-gen console version3DS Version

turn off platform icons:

BeeswaxBeeswax(note)

turn on platform icons, and turn on small icons:

BeeswaxBeeswax(note)Old-gen console version3DS Version

turn on line wrap, and set to text mode:

BeeswaxOld-gen console version3DS Version(note)

turn on no link mode:

BeeswaxOld-gen console version3DS Version(note)

This will be overrided by link=

Beeswax(note)

get current setting:

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

reset all options:

BeeswaxBeeswax(note)Old-gen console version3DS Version

custom css and class:

BeeswaxBeeswax(note)Old-gen console version3DS Version

BeeswaxBeeswax(note)Old-gen console version3DS Version

reset all:

BeeswaxBeeswax(note)Old-gen console version3DS Version

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 ChestGolden ChestDesktop Version Golden ChestGolden ChestDesktop Version

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}}: OreOre
(links to Copper Ore)
{{item|Copper Ore|Minerale}}: MineraleMinerale
(links to Copper Ore/it)
{{item|Minerale di rame}}: Minerale di rameMinerale di rame
{{item|Minerale di rame|Minerale}}: MineraleMinerale
(image and link are borken.)