Template:Item/doc: Difference between revisions
Mastergalen (talk | contribs) m (1 revision) |
No edit summary |
||
Line 1: | Line 1: | ||
{{doc/start}} | {{doc/start}} | ||
{{lua|Infobox}} | |||
{{Item}} | {{Item}} | ||
This template provides a uniform design for usable item pages. When an item restores health, it is recommended to use [[Template:Food]] instead. | This template provides a uniform design for usable item pages. When an item restores health, it is recommended to use [[Template:Food]] instead. | ||
Line 6: | Line 7: | ||
|title= | |title= | ||
|image= | |image= | ||
|imagesize= | |||
|image2= | |image2= | ||
|image2size= | |||
|image3= | |image3= | ||
|image3size= | |||
|invimage= | |invimage= | ||
|invimage2= | |invimage2= | ||
Line 38: | Line 42: | ||
|renewable= | |renewable= | ||
|stackable= | |stackable= | ||
|availability= | |||
|data= | |data= | ||
|nameid= | |||
|firstver= | |firstver= | ||
}}</pre> | }}</pre> | ||
Line 44: | Line 50: | ||
Please note that if the item has multiple data values, use <code><nowiki>|multipledata=</nowiki></code> instead. See below: | Please note that if the item has multiple data values, use <code><nowiki>|multipledata=</nowiki></code> instead. See below: | ||
{| | {| class="wikitable" | ||
! Parameter | ! Parameter | ||
! Function | ! Function | ||
Line 52: | Line 58: | ||
|- | |- | ||
| <code>image</code> || Image of the block (should be approx. 150x150px) || <code><nowiki>{{{title}}}.png</nowiki></code> if it exists, otherwise [[:File:No image.svg|No image.svg]] (linking to the page where to upload the missing image) | | <code>image</code> || Image of the block (should be approx. 150x150px) || <code><nowiki>{{{title}}}.png</nowiki></code> if it exists, otherwise [[:File:No image.svg|No image.svg]] (linking to the page where to upload the missing image) | ||
|- | |||
| <code>imagesize</code> || Adjusts the size of the image || 150px | |||
|- | |- | ||
| <code>image2</code> || Image of the block (should be approx. 150x150px) || ''None'' | | <code>image2</code> || Image of the block (should be approx. 150x150px) || ''None'' | ||
|- | |||
| <code>image2size</code> || Adjusts the size of the second image || 150px | |||
|- | |- | ||
| <code>image3</code> || Image of the block (should be approx. 150x150px) || ''None'' | | <code>image3</code> || Image of the block (should be approx. 150x150px) || ''None'' | ||
|- | |||
| <code>image3size</code> || Adjusts the size of the third image || 150px | |||
|- | |- | ||
| <code>invimage</code> || Image for object in inventory. Can use '''None''' to force no invimage. Uses [[Template:Grid]]. || <code><nowiki>Grid {{{title}}}.png</nowiki></code> if it exists, otherwise ''None'' | | <code>invimage</code> || Image for object in inventory. Can use '''None''' to force no invimage. Uses [[Template:Grid]]. || <code><nowiki>Grid {{{title}}}.png</nowiki></code> if it exists, otherwise ''None'' | ||
Line 112: | Line 124: | ||
|- | |- | ||
| <code>durability</code> || How durable the item is || N/A | | <code>durability</code> || How durable the item is || N/A | ||
|- | |||
| <code>renewable</code> || Whether the item is [[Renewable Resources|renewable]] || ? | |||
|- | |- | ||
| <code>stackable</code> || Stackable || ? | | <code>stackable</code> || Stackable || ? | ||
|- | |||
| <code>availability </code> || The availability of an item || ? | |||
|- | |- | ||
| <code>data</code> || Single decimal data value || ''None'' | | <code>data</code> || Single decimal data value || ''None'' | ||
|- | |||
| <code>nameid</code> || The item's named identifier. Can use '''None''' to force no name ID. || <code>title</code> or <code><nowiki>{{BASEPAGENAME}}</nowiki></code> | |||
|- | |- | ||
| <code>multipledata</code> || Multiple decimal data values, use {{tl|dv}} || ''None'' | | <code>multipledata</code> || Multiple decimal data values, use {{tl|dv}} || ''None'' | ||
Line 124: | Line 142: | ||
== See also == | == See also == | ||
{{Infobox see also}} | {{Infobox see also}} | ||
{{doc/end}} | {{doc/end}} | ||
Revision as of 14:50, 14 February 2014
This template uses Module:Infobox, a script written in the Lua programming language. Please see wp:Lua and mw:Extension:Scribunto to learn more about Lua. |
Item
Type |
? |
---|---|
Durability |
N/A |
Renewable |
? |
Stackable |
? |
This template provides a uniform design for usable item pages. When an item restores health, it is recommended to use Template:Food instead.
{{Item |title= |image= |imagesize= |image2= |image2size= |image3= |image3size= |invimage= |invimage2= |invimage3= |invimage4= |invimage5= |invimage6= |invimage7= |invimage8= |invimage9= |invimage10= |invimage11= |invimage12= |invimage13= |invimage14= |invimage15= |invimage16= |invimage17= |invimage18= |invimage19= |invimage20= |invimage21= |invimage22= |invimage23= |invimage24= |invimage25= |type= |otherosonly= |durability= |renewable= |stackable= |availability= |data= |nameid= |firstver= }}
Please note that if the item has multiple data values, use |multipledata=
instead. See below:
Parameter | Function | Default/Example value |
---|---|---|
title |
Optional value to use a different title instead of the page name | {{BASEPAGENAME}}
|
image |
Image of the block (should be approx. 150x150px) | {{{title}}}.png if it exists, otherwise No image.svg (linking to the page where to upload the missing image)
|
imagesize |
Adjusts the size of the image | 150px |
image2 |
Image of the block (should be approx. 150x150px) | None |
image2size |
Adjusts the size of the second image | 150px |
image3 |
Image of the block (should be approx. 150x150px) | None |
image3size |
Adjusts the size of the third image | 150px |
invimage |
Image for object in inventory. Can use None to force no invimage. Uses Template:Grid. | Grid {{{title}}}.png if it exists, otherwise None
|
invimage2 |
Second image for two-state objects in inventory. Uses Template:Grid. | None |
invimage3 |
Third image for three-state objects in inventory. Uses Template:Grid. | None |
invimage4 |
Fourth image for four-state objects in inventory. Uses Template:Grid. | None |
invimage5 |
Fifth image for five-state objects in inventory. Uses Template:Grid. | None |
invimage6 |
Sixth image for six-state objects in inventory. Uses Template:Grid. | None |
invimage7 |
Seventh image for seven-state objects in inventory. Uses Template:Grid. | None |
invimage8 |
Eighth image for eight-state objects in inventory. Uses Template:Grid. | None |
invimage9 |
Ninth image for nine-state objects in inventory. Uses Template:Grid. | None |
invimage10 |
Tenth image for ten-state objects in inventory. Uses Template:Grid. | None |
invimage11 |
Eleventh image for eleven-state objects in inventory. Uses Template:Grid. | None |
invimage12 |
Twelfth image for twelve-state objects in inventory. Uses Template:Grid. | None |
invimage13 |
Thirteenth image for thirteen-state objects in inventory. Uses Template:Grid. | None |
invimage14 |
Fourteenth image for fourteen-state objects in inventory. Uses Template:Grid. | None |
invimage15 |
Fifteenth image for fifteen-state objects in inventory. Uses Template:Grid. | None |
invimage16 |
Sixteenth image for sixteen-state objects in inventory. Uses Template:Grid. | None |
invimage17 |
Seventeenth image for seventeen-state objects in inventory. Uses Template:Grid. | None |
invimage18 |
Eighteenth image for eighteen-state objects in inventory. Uses Template:Grid. | None |
invimage19 |
Nineteenth image for nineteen-state objects in inventory. Uses Template:Grid. | None |
invimage20 |
Twentieth image for twenty-state objects in inventory. Uses Template:Grid. | None |
invimage21 |
Twenty-First image for twenty-one-state objects in inventory. Uses Template:Grid. | None |
invimage22 |
Twenty-Second image for twenty-two-state objects in inventory. Uses Template:Grid. | None |
invimage23 |
Twenty-Third image for twenty-three-state objects in inventory. Uses Template:Grid. | None |
invimage24 |
Twenty-Forth image for twenty-four-state objects in inventory. Uses Template:Grid. | None |
invimage25 |
Twenty-Fifth image for twenty-five-state objects in inventory. Uses Template:Grid. | None |
type |
Type (Weapon, Ranged Weapon, Craftable Item, Tool, etc. ) | ? |
otherosonly |
For use if the item is only available in a specific version of Minecraft. | None |
durability |
How durable the item is | N/A |
renewable |
Whether the item is renewable | ? |
stackable |
Stackable | ? |
availability |
The availability of an item | ? |
data |
Single decimal data value | None |
nameid |
The item's named identifier. Can use None to force no name ID. | title or {{BASEPAGENAME}}
|
multipledata |
Multiple decimal data values, use {{dv}} | None |
firstver |
First version that it was seen in (e.g. Alpha 1.0.17, classic 0.0.23a). | None |
See also
- {{3rd Party Tool}}
- {{Block}}
- {{BlockTileEntity}}
- {{Entity}}
- {{Food}}
- {{Gamemode}}
- {{Item}}
- {{ItemEntity}}
- {{Mod}}
- {{Person}}
- {{Potion}}
- {{Profile}}
- {{Program}}
- {{Structure}}
- {{Technical Block}}
- {{Version nav}}
- Module:Infobox
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.