Toggle search
Toggle menu
109
3K
29
7.3K
Vault Hunters Official Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Inventory slot/doc

Template page
More actions
This is the documentation page. It should be transcluded into Template:Inventory slot. See Template:Documentation for more information.
Shortcut
File:Lua Logo.svg
This template uses Module:Inventory slot, with data stored in Module:Inventory slot/Aliases.
These scripts are written in 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, or Grid <item name> (<mod name>).png in case of mods (which are currently being phased out). GIF files are also supported for animated icons.

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: {{Slot|Raw Porkchop,20}}

shows

Inventory sprite for Raw Porkchop linking to Raw Porkchop2020

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

Inventory sprite for Oak Log linking to Oak LogInventory sprite for Spruce Log linking to Spruce LogInventory sprite for Birch Log linking to Birch LogInventory sprite for Jungle Log linking to Jungle LogInventory sprite for Acacia Log linking to Acacia LogInventory sprite for Dark Oak Log linking to Dark Oak LogInventory sprite for Mangrove Log linking to Mangrove LogInventory sprite for Cherry Log linking to Cherry LogInventory sprite for Pale Oak Log linking to Pale Oak LogInventory sprite for Golden Apple linking to Golden Apple


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

Inventory sprite for Oak Log linking to Oak Log44Inventory sprite for Spruce Log linking to Spruce Log44Inventory sprite for Birch Log linking to Birch Log44Inventory sprite for Jungle Log linking to Jungle Log44Inventory sprite for Acacia Log linking to Acacia Log44Inventory sprite for Dark Oak Log linking to Dark Oak Log44Inventory sprite for Mangrove Log linking to Mangrove Log44Inventory sprite for Cherry Log linking to Cherry Log44Inventory sprite for Pale Oak Log linking to Pale Oak Log44Inventory sprite for Enchanted Golden Apple linking to 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.

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

shows

Inventory sprite for Raw Porkchop linking to Raw PorkchopInventory sprite for Cooked Porkchop linking to Cooked Porkchop


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

shows

Inventory sprite for Raw Porkchop linking to Raw PorkchopInventory sprite for Cooked Porkchop linking to Cooked Porkchop


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

Inventory sprite for Diamond Sword linking to 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 (/).

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

shows

Inventory sprite for Iron Sword linking to Iron Sword

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

Inventory sprite for Oak Planks linking to Oak PlanksInventory sprite for Spruce Planks linking to Spruce PlanksInventory sprite for Birch Planks linking to Birch PlanksInventory sprite for Jungle Planks linking to Jungle PlanksInventory sprite for Acacia Planks linking to Acacia PlanksInventory sprite for Dark Oak Planks linking to Dark Oak PlanksInventory sprite for Mangrove Planks linking to Mangrove PlanksInventory sprite for Cherry Planks linking to Cherry PlanksInventory sprite for Pale Oak Planks linking to Pale Oak PlanksInventory sprite for Bamboo Planks linking to Bamboo PlanksInventory sprite for Crimson Planks linking to Crimson PlanksInventory sprite for Warped Planks linking to Warped PlanksInventory sprite for Oak Planks linking to Oak PlanksInventory sprite for Spruce Planks linking to Spruce PlanksInventory sprite for Birch Planks linking to Birch PlanksInventory sprite for Jungle Planks linking to Jungle PlanksInventory sprite for Acacia Planks linking to Acacia PlanksInventory sprite for Dark Oak Planks linking to Dark Oak PlanksInventory sprite for Mangrove Planks linking to Mangrove PlanksInventory sprite for Cherry Planks linking to Cherry PlanksInventory sprite for Pale Oak Planks linking to Pale Oak PlanksInventory sprite for Bamboo Planks linking to Bamboo PlanksInventory sprite for Crimson Planks linking to Crimson PlanksInventory sprite for Warped Planks linking to Warped PlanksInventory sprite for Iron Ingot linking to Iron Ingot

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 Inventory sprite for Raw Porkchop linking to Raw Porkchop in here!

Default

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

shows

Inventory sprite for Mundane Splash Potion linking to Mundane Splash Potion

Link

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

shows

Inventory sprite for Charcoal linking to Coal#Charcoal


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

shows

Inventory sprite for Charcoal

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. 

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

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

shows

Inventory sprite for Oak Planks linking to Oak PlanksInventory sprite for Spruce Planks linking to Spruce PlanksInventory sprite for Birch Planks linking to Birch PlanksInventory sprite for Jungle Planks linking to Jungle PlanksInventory sprite for Acacia Planks linking to Acacia PlanksInventory sprite for Dark Oak Planks linking to Dark Oak PlanksInventory sprite for Mangrove Planks linking to Mangrove PlanksInventory sprite for Cherry Planks linking to Cherry PlanksInventory sprite for Pale Oak Planks linking to Pale Oak PlanksInventory sprite for Bamboo Planks linking to Bamboo PlanksInventory sprite for Crimson Planks linking to Crimson PlanksInventory sprite for Warped Planks linking to Warped PlanksInventory sprite for Oak Slab linking to Oak SlabInventory sprite for Spruce Slab linking to Spruce SlabInventory sprite for Birch Slab linking to Birch SlabInventory sprite for Jungle Slab linking to Jungle SlabInventory sprite for Acacia Slab linking to Acacia SlabInventory sprite for Dark Oak Slab linking to Dark Oak SlabInventory sprite for Mangrove Slab linking to Mangrove SlabInventory sprite for Cherry Slab linking to Cherry SlabInventory sprite for Pale Oak Slab linking to Pale Oak SlabInventory sprite for Bamboo Slab linking to Bamboo SlabInventory sprite for Crimson Slab linking to Crimson SlabInventory sprite for Warped Slab linking to Warped SlabInventory sprite for Oak Stairs linking to Oak StairsInventory sprite for Spruce Stairs linking to Spruce StairsInventory sprite for Birch Stairs linking to Birch StairsInventory sprite for Jungle Stairs linking to Jungle StairsInventory sprite for Acacia Stairs linking to Acacia StairsInventory sprite for Dark Oak Stairs linking to Dark Oak StairsInventory sprite for Mangrove Stairs linking to Mangrove StairsInventory sprite for Cherry Stairs linking to Cherry StairsInventory sprite for Pale Oak Stairs linking to Pale Oak StairsInventory sprite for Bamboo Stairs linking to Bamboo StairsInventory sprite for Crimson Stairs linking to Crimson StairsInventory sprite for Warped Stairs linking to Warped Stairs

Inventory sprite for Oak Planks linking to Oak PlanksInventory sprite for Spruce Planks linking to Spruce PlanksInventory sprite for Birch Planks linking to Birch PlanksInventory sprite for Jungle Planks linking to Jungle PlanksInventory sprite for Acacia Planks linking to Acacia PlanksInventory sprite for Dark Oak Planks linking to Dark Oak PlanksInventory sprite for Mangrove Planks linking to Mangrove PlanksInventory sprite for Cherry Planks linking to Cherry PlanksInventory sprite for Pale Oak Planks linking to Pale Oak PlanksInventory sprite for Bamboo Planks linking to Bamboo PlanksLua error: too many expensive function calls.Lua error: too many expensive function calls.

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



Retrieved from "https://wiki.vaulthunters.gg/index.php?title=Template:Inventory_slot/doc&oldid=405"