View source for Template:Inventory slot/doc

{{documentation header}}
{{shortcut|Slot}}
{{lua|data=Inventory slot/Aliases}}
The inventory slot template creates an interface element which looks and acts like an in-game inventory slot.

The images used have the <code>Invicon ''<item name>''.png</code> name format, or <code>Grid ''<item name>'' (''<mod name>'').png</code> in case of [[mods]] (which are currently being phased out). GIF files are also supported for animated icons.

== Usage ==
All inputs are optional:<br>
<pre>{{Slot
|[Title]Mod:Name,Amount[Description]; [Title2]Mod2:Name2,Amount2[Description2]; ...
|mod=Default mod (useful for animations and layout templates)
|default=Image always shown under the main image
|align=Vertical Alignment
|link=Link override
|title=Text show on mouseover
|class=Adds additional classes to the .invslot class
|style=Adds styling to the .invslot
|imgclass=Adds additional classes to the .invslot-item
|numstyle=Adds styling to the stack number
}}</pre>

=== Parts ===
The first parameter is a special parameter consisting of various "parts" grouped together in frames (delimited by <code>;</code>) which will be display one after another if JavaScript is enabled. Every part is optional, but without "name", won't do anything. The "name" can also include the image's extension following a dot (<code>.png</code> or <code>.gif</code>).

==== Simple example ====
To display an inventory item of "Raw Porkchop" with an stack size of 20 you would put: {{t|Slot|Raw Porkchop,20}}
;shows
{{Slot|Raw Porkchop,20}}

An amount of 2–999 is supported, anything else will not be displayed.

=== Aliases ===
{{#invoke: Inventory slot/Aliases/Table | table }}
Note: Banner variations are not included due to how many there are.

The above aliases can be used to shorten common items, such as all wood blocks or adding parts to certain names by default.

{{t|Slot|Any Log;Golden Apple}}

;shows
{{Slot|Any Log;Golden Apple}}


When using the alias, parts can be added which will override any parts in the alias.

{{t|Slot|Any Log,4;[&oShiny Apple]Enchanted Golden Apple}}

;shows
{{Slot|Any Log,4;[&oShiny Apple]Enchanted Golden Apple}}


Mods can specify an additional aliases table using the modaliases parameter.

=== Titles and description ===
The title parameter can be used to set a title for all frames.

{{t|Slot|Raw Porkchop; Cooked Porkchop|title{{=}}Smelly Porkchop}}
;shows
{{Slot|Raw Porkchop; Cooked Porkchop|title=Smelly Porkchop}}


To remove the title, set it to "none": {{t|Slot|Raw Porkchop; Cooked Porkchop|title{{=}}none}}
;shows
{{Slot|Raw Porkchop; Cooked Porkchop|title=none}}


However, the first bracketed text can be used to specify a title for each frame individually, and also supports standard [[formatting codes]] using <code>&</code> instead of <code>§</code>. If the title only contains formatting codes and no actual text, the formatting will be added to the normal title.

{{t|Slot|[&b]Diamond Sword}}
;shows
{{Slot|[&b]Diamond Sword}}


The last bracketed text can be used to specify a description, this also supports standard formatting codes, and can also have multiple lines by using forward slashes (/).

{{t|Slot|[&b&oExcalibur]Iron Sword[&7Smite V/Fire Aspect I//&9+6 Attack Damage]}}
;shows
{{Slot|[&b&oExcalibur]Iron Sword[&7Smite V/Fire Aspect I//&9+6 Attack Damage]}}

=== Subframes ===

Subframes are shown as a single frame, but the frames within it are advanced every time the subframe is displayed. A set of frames can be put in a subframe by wrapping it in braces.

Here, an alias (which resolves to multiple frames) is wrapped in a subframe, and a different wood plank variant is shown each animation cycle:

{{t|Slot|{Any Planks};Iron Ingot}}
;shows
{{Slot|{Any Planks};Iron Ingot}}

=== Align ===
Align uses the [http://www.w3.org/wiki/CSS/Properties/vertical-align vertical-align] CSS property. For example to align to the middle:
<code><nowiki>Smells like {{Slot|Raw Porkchop|align=middle}} in here!</nowiki></code>
;shows
Smells like {{Slot|Raw Porkchop|align=middle}} in here!

=== Default ===
Default is always shown and is placed under the image. {{t|Slot|default{{=}}Brewing}}{{t|Slot|Mundane Splash Potion|default{{=}}Brewing}}
;shows
{{Slot|default=Brewing}}{{Slot|Mundane Splash Potion|default=Brewing}}

=== Link ===
To change the link for all frames from the image name put: {{t|Slot|Charcoal|link{{=}}Coal#Charcoal}}
;shows
{{Slot|Charcoal|link=Coal#Charcoal}}


To remove the link, set link to none: {{t|Slot|Charcoal|link{{=}}none}}
;shows
{{Slot|Charcoal|link=none}}

Note that this retains the title.

== Available images ==

In general, an item can be referred to by its tooltip name.

For dyes, dyed items and wood, there are two shortcuts to refer to all colors or tree species. Use e.g. "Any Overworld Wooden Planks" if the item appears in more than one input slot and doesn't have to be the same color in all slots. Different copies of the same "Any [item]" will switch randomly and separately among the variants. Otherwise, use "Matching [item]"; all slots containing a "Matching" item will cycle through the species or dye colors in unison, even if they're not the same item.

<pre>
{{Slot|Any Planks}}{{Slot|Any Wooden Slab}}{{Slot|Any Wooden Stairs}}

{{Slot|Matching Overworld Planks}}{{Slot|Matching Overworld Wooden Slab}}{{Slot|Matching Wooden Stairs}}
</pre>

'''shows'''

{{Slot|Any Planks}}{{Slot|Any Wooden Slab}}{{Slot|Any Wooden Stairs}}

{{Slot|Matching Overworld Planks}}{{Slot|Matching Overworld Wooden Slab}}{{Slot|Matching Wooden Stairs}}

Most items with a durability bar exist as "Damaged [item]".

See [[Template:InvSprite]] for the full list of items.

== Other templates ==

These templates implement this template into a GUI screen which mimics how it would look in Minecraft. Thus, they have mostly the same features as this template.
{{UI see also}}

<includeonly>
<!-- Template categories/interwiki here -->
[[Category:Image templates]]
[[Category:Inventory templates]]
</includeonly>
<noinclude>
<!-- Documentation categories/interwiki here -->
</noinclude>