Template:Inventory slot/doc: Difference between revisions
(Created page with "{{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:<b...") |
(fixing the documentation to work on our wiki) |
||
Line 1: | Line 1: | ||
⚫ | |||
{{documentation header}} |
|||
⚫ | |||
⚫ | |||
⚫ | |||
The inventory slot template creates an interface element which looks and acts like an in-game inventory slot. |
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 |
The images used have the <code>Invicon ''<item name>''.png</code> name format. GIF files are also supported for animated icons, for items that can be both animated and not (an enchanted bow vs an unenchanted bow etc.) add .gif to the item name to select the animated form. |
||
== Usage == |
== Usage == |
||
Line 37: | Line 36: | ||
The above aliases can be used to shorten common items, such as all wood blocks or adding parts to certain names by default. |
The above aliases can be used to shorten common items, such as all wood blocks or adding parts to certain names by default. |
||
{{ |
<code><nowiki>{{Slot|Any Log;Golden Apple}}</nowiki></code> |
||
;shows |
;shows |
||
Line 45: | Line 44: | ||
When using the alias, parts can be added which will override any parts in the alias. |
When using the alias, parts can be added which will override any parts in the alias. |
||
{{ |
<code><nowiki>{{Slot|Any Log,4;[&oShiny Apple]Enchanted Golden Apple}}</nowiki></code> |
||
;shows |
;shows |
||
Line 56: | Line 55: | ||
The title parameter can be used to set a title for all frames. |
The title parameter can be used to set a title for all frames. |
||
{{ |
<code><nowiki>{{Slot|Raw Porkchop; Cooked Porkchop|title=Smelly Porkchop}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|Raw Porkchop; Cooked Porkchop|title=Smelly Porkchop}} |
{{Slot|Raw Porkchop; Cooked Porkchop|title=Smelly Porkchop}} |
||
To remove the title, set it to "none": {{ |
To remove the title, set it to "none": <code><nowiki>{{Slot|Raw Porkchop; Cooked Porkchop|title=none}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|Raw Porkchop; Cooked Porkchop|title=none}} |
{{Slot|Raw Porkchop; Cooked Porkchop|title=none}} |
||
Line 68: | Line 67: | ||
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. |
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. |
||
{{ |
<code><nowiki>{{Slot|[&b]Diamond Sword}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|[&b]Diamond Sword}} |
{{Slot|[&b]Diamond Sword}} |
||
Line 75: | Line 74: | ||
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 (/). |
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 (/). |
||
{{ |
<code><nowiki>{{Slot|[&b&oExcalibur]Iron Sword[&7Smite V/Fire Aspect I//&9+6 Attack Damage]}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|[&b&oExcalibur]Iron Sword[&7Smite V/Fire Aspect I//&9+6 Attack Damage]}} |
{{Slot|[&b&oExcalibur]Iron Sword[&7Smite V/Fire Aspect I//&9+6 Attack Damage]}} |
||
Line 85: | Line 84: | ||
Here, an alias (which resolves to multiple frames) is wrapped in a subframe, and a different wood plank variant is shown each animation cycle: |
Here, an alias (which resolves to multiple frames) is wrapped in a subframe, and a different wood plank variant is shown each animation cycle: |
||
{{ |
<code><nowiki>{{Slot|{Any Planks};Iron Ingot}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|{Any Planks};Iron Ingot}} |
{{Slot|{Any Planks};Iron Ingot}} |
||
Line 94: | Line 93: | ||
;shows |
;shows |
||
Smells like {{Slot|Raw Porkchop|align=middle}} in here! |
Smells like {{Slot|Raw Porkchop|align=middle}} in here! |
||
As opposed to <code><nowiki>Smells like {{Slot|Raw Porkchop}} in here!</nowiki></code> showing as |
|||
Smells like {{Slot|Raw Porkchop}} in here! |
|||
=== Default === |
=== Default === |
||
Default is always shown and is placed under the image. {{ |
Default is always shown and is placed under the image. <code><nowiki>{{Slot|default=Brewing}}{{Slot|Splash Mundane Potion|default=Brewing}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|default=Brewing}}{{Slot|Splash Mundane Potion|default=Brewing}} |
{{Slot|default=Brewing}}{{Slot|Splash Mundane Potion|default=Brewing}} |
||
=== Animation === |
|||
Some items will always be animated such as a Compass, when there's an animated version add .gif to the item name to select the animated form or for enchantable items you can instead add Enchanted to the front of the name.<br> |
|||
<code><nowiki>{{Slot|Compass}} {{Slot|Diamond Sword}} {{Slot|Diamond Sword.gif}} {{Slot|Enchanted Diamond Sword}} </nowiki></code> |
|||
;shows |
|||
{{Slot|Compass}} {{Slot|Diamond Sword}} {{Slot|Diamond Sword.gif}} {{Slot|Enchanted Diamond Sword}} |
|||
=== Link === |
=== Link === |
||
To change the link for all frames from the image name put: {{ |
To change the link for all frames from the image name put: <code><nowiki>{{Slot|Charcoal|link=Coal#Charcoal}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|Charcoal|link=Coal#Charcoal}} |
{{Slot|Charcoal|link=Coal#Charcoal}} |
||
To remove the link, set link to none: {{ |
To remove the link, set link to none: <code><nowiki>{{Slot|Charcoal|link=none}}</nowiki></code> |
||
;shows |
;shows |
||
{{Slot|Charcoal|link=none}} |
{{Slot|Charcoal|link=none}} |
||
Line 141: | Line 149: | ||
<includeonly> |
<includeonly> |
||
<!-- Template categories/interwiki here --> |
<!-- Template categories/interwiki here --> |
||
[[Category:Image templates]] |
|||
[[Category:Inventory templates]] |
|||
[[es:Plantilla:Inventory slot]] |
|||
[[fr:Modèle:Case inventaire]] |
|||
[[ja:テンプレート:Inventory slot]] |
|||
[[pt:Predefinição:Compartimento de inventário]] |
|||
[[ru:Шаблон:Инвентарный слот]] |
|||
[[uk:Шаблон:Інвентарний слот]] |
|||
</includeonly> |
</includeonly> |
||
<noinclude> |
<noinclude> |
||
<!-- Documentation categories/interwiki here --> |
|||
[[de: Inventar slot/Dokumentation ]] |
|||
[[es:Plantilla:Inventory slot/doc]] |
|||
[[fr:Modèle:Case inventaire/doc]] |
|||
[[ja:テンプレート:Inventory slot/doc]] |
|||
[[pt:Predefinição:Compartimento de inventário/doc]] |
|||
[[ru:Шаблон:Инвентарный слот/док]] |
|||
[[uk:Шаблон:Інвентарний слот/док]] |
|||
</noinclude> |
</noinclude> |
Revision as of 09:35, 24 January 2024
This template uses Lua: |
The inventory slot template creates an interface element which looks and acts like an in-game inventory slot.
The images used have the Invicon <item name>.png
name format. GIF files are also supported for animated icons, for items that can be both animated and not (an enchanted bow vs an unenchanted bow etc.) add .gif to the item name to select the animated form.
Usage
All inputs are optional:
{{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 }}
Parts
The first parameter is a special parameter consisting of various "parts" grouped together in frames (delimited by ;
) 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 (.png
or .gif
).
Simple example
To display an inventory item of "Raw Porkchop" with an stack size of 20 you would put: Template:T
- shows
[[|20]]
An amount of 2–999 is supported, anything else will not be displayed.
Aliases
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.
{{Slot|Any Log;Golden Apple}}
- shows
When using the alias, parts can be added which will override any parts in the alias.
{{Slot|Any Log,4;[&oShiny Apple]Enchanted Golden Apple}}
- shows
[[|4]]
[[|4]]
[[|4]]
[[|4]]
[[|4]]
[[|4]]
[[|4]]
[[|4]]
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.
{{Slot|Raw Porkchop; Cooked Porkchop|title=Smelly Porkchop}}
- shows
To remove the title, set it to "none": {{Slot|Raw Porkchop; Cooked Porkchop|title=none}}
- shows
However, the first bracketed text can be used to specify a title for each frame individually, and also supports standard formatting codes using &
instead of §
. If the title only contains formatting codes and no actual text, the formatting will be added to the normal title.
{{Slot|[&b]Diamond Sword}}
- shows
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 (/).
{{Slot|[&b&oExcalibur]Iron Sword[&7Smite V/Fire Aspect I//&9+6 Attack Damage]}}
- shows
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:
{{Slot|{Any Planks};Iron Ingot}}
- shows
Align
Align uses the vertical-align CSS property. For example to align to the middle:
Smells like {{Slot|Raw Porkchop|align=middle}} in here!
- shows
Smells like in here!
As opposed to Smells like {{Slot|Raw Porkchop}} in here!
showing as
Smells like in here!
Default
Default is always shown and is placed under the image. {{Slot|default=Brewing}}{{Slot|Splash Mundane Potion|default=Brewing}}
- shows
Animation
Some items will always be animated such as a Compass, when there's an animated version add .gif to the item name to select the animated form or for enchantable items you can instead add Enchanted to the front of the name.
{{Slot|Compass}} {{Slot|Diamond Sword}} {{Slot|Diamond Sword.gif}} {{Slot|Enchanted Diamond Sword}}
- shows
Link
To change the link for all frames from the image name put: {{Slot|Charcoal|link=Coal#Charcoal}}
- shows
To remove the link, set link to none: {{Slot|Charcoal|link=none}}
- shows
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 Wood 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.
{{Slot|Any Planks}}{{Slot|Any wood Slab}}{{Slot|Any wood Stairs}} {{Slot|Matching Wood Planks}}{{Slot|Matching Wood Slab}}{{Slot|Matching wood Stairs}}
shows
Invicon Bamboo Slab.png: Inventory sprite for Bamboo Slab in Minecraft as shown in-game linking to with description: Bamboo Slab
Invicon Bamboo Stairs.png: Inventory sprite for Bamboo Stairs in Minecraft as shown in-game linking to with description: Bamboo Stairs
Invicon Bamboo Slab.png: Inventory sprite for Bamboo Slab in Minecraft as shown in-game linking to with description: Bamboo Slab
Invicon Bamboo Stairs.png: Inventory sprite for Bamboo Stairs in Minecraft as shown in-game linking to with description: Bamboo 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. Template:UI see also