Template:Grid/doc

This template uses Module:Grid, a script written in the Lua programming language. Please see wp:Lua and mw:Extension:Scribunto to learn more about Lua.

The grid template is a singular grid cell, which has the ability to display any image (usually a block or item) that is uploaded as Grid <Name>.png, within it.

Usage

All inputs are optional:

{{Grid
|[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 .grid class
|style=Adds styling to the .grid
|imgclass=Adds additional classes to the .item
|numstyle=Adds styling to the 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.

Simple example

To display this image File:Grid Raw Porkchop.png with an amount of 20 you would put: {{Grid|Raw Porkchop,20}}

shows

20

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

If no image is specified, the background will be added on its own, this could be used to do layouts like so:

{{Grid|TNT}}{{Grid|TNT}}{{Grid}}{{Grid}}{{Grid|TNT}}{{Grid|TNT}}<br>
{{Grid|TNT}}{{Grid|TNT}}{{Grid}}{{Grid}}{{Grid|TNT}}{{Grid|TNT}}<br>
{{Grid}}{{Grid}}{{Grid|TNT}}{{Grid|TNT}}{{Grid}}{{Grid}}<br>
{{Grid}}{{Grid|TNT}}{{Grid|TNT}}{{Grid|TNT}}{{Grid|TNT}}{{Grid}}<br>
{{Grid}}{{Grid|TNT}}{{Grid|TNT}}{{Grid|TNT}}{{Grid|TNT}}{{Grid}}<br>
{{Grid}}{{Grid|TNT}}{{Grid}}{{Grid}}{{Grid|TNT}}{{Grid}}

shows

However this is really inefficient and produces ugly code, so don't do this. Use Template:BlockGrid or Template:Schematic instead.

Aliases

return {
    ['Any fuel'] = 'Coal; Charcoal; Oak Wood; Oak Wood Planks',
	['Any Wood'] = 'Oak Wood; Spruce Wood; Birch Wood; Jungle Wood; Acacia Wood; Dark Oak Wood',
	['Any Wood Planks'] = 'Oak Wood Planks; Spruce Wood Planks; Birch Wood Planks; Jungle Wood Planks; Acacia Wood Planks; Dark Oak Wood Planks',
	['Any Wood Stairs'] = 'Oak Wood Stairs; Spruce Wood Stairs; Birch Wood Stairs; Jungle Wood Stairs; Acacia Wood Stairs; Dark Oak Wood Stairs',
	['Any Wood Slab'] = 'Oak Wood Slab; Spruce Wood Slab; Birch Wood Slab; Jungle Wood Slab; Acacia Wood Slab; Dark Oak Wood Slab',
	['Any Wool'] = 'Orange Wool; Magenta Wool; Light Blue Wool; Yellow Wool; Lime Wool; Pink Wool; Gray Wool; Light Gray Wool; Cyan Wool; Purple Wool; Blue Wool; Brown Wool; Green Wool; Red Wool; Black Wool',
	['Any Carpet'] = 'White Carpet; Orange Carpet; Magenta Carpet; Light Blue Carpet; Yellow Carpet; Lime Carpet; Pink Carpet; Gray Carpet; Light Gray Carpet; Cyan Carpet; Purple Carpet; Blue Carpet; Brown Carpet; Green Carpet; Red Carpet; Black Carpet',
	['Any Dye'] = 'Orange Dye; Magenta Dye; Light Blue Dye; Dandelion Yellow; Lime Dye; Pink Dye; Gray Dye; Light Gray Dye; Cyan Dye; Purple Dye; Lapis Lazuli; Cocoa Beans; Cactus Green; Rose Red; Ink Sac',
	['Any Sandstone'] = 'Sandstone; Chiseled Sandstone; Smooth Sandstone',
	['Any Quartz Block'] = 'Block of Quartz; Chiseled Quartz Block; Pillar Quartz Block',
	['Any Stone Bricks'] = 'Stone Bricks; Mossy Stone Bricks; Cracked Stone Bricks; Chiseled Stone Brick',
	['Any Stained Glass'] = 'White Stained Glass; Orange Stained Glass; Magenta Stained Glass; Light Blue Stained Glass; Yellow Stained Glass; Lime Stained Glass; Pink Stained Glass; Gray Stained Glass; Light Gray Stained Glass; Cyan Stained Glass; Purple Stained Glass; Blue Stained Glass; Brown Stained Glass; Green Stained Glass; Red Stained Glass; Black Stained Glass',
	['Any Stained Glass Pane'] = 'White Stained Glass Pane; Orange Stained Glass Pane; Magenta Stained Glass Pane; Light Blue Stained Glass Pane; Yellow Stained Glass Pane; Lime Stained Glass Pane; Pink Stained Glass Pane; Gray Stained Glass Pane; Light Gray Stained Glass Pane; Cyan Stained Glass Pane; Purple Stained Glass Pane; Blue Stained Glass Pane; Brown Stained Glass Pane; Green Stained Glass Pane; Red Stained Glass Pane; Black Stained Glass Pane',
	['Any Stained Clay'] = 'White Stained Clay; Orange Stained Clay; Magenta Stained Clay; Light Blue Stained Clay; Yellow Stained Clay; Lime Stained Clay; Pink Stained Clay; Gray Stained Clay; Light Gray Stained Clay; Cyan Stained Clay; Purple Stained Clay; Blue Stained Clay; Brown Stained Clay; Green Stained Clay; Red Stained Clay; Black Stained Clay',
	['Any Firework Star'] = 'White Firework Star; Orange Firework Star; Magenta Firework Star; Light Blue Firework Star; Yellow Firework Star; Lime Firework Star; Pink Firework Star; Gray Firework Star; Light Gray Firework Star; Cyan Firework Star; Purple Firework Star; Blue Firework Star; Brown Firework Star; Green Firework Star; Red Firework Star; Black Firework Star',
	['Golden Apple'] = '[&b]Golden Apple',
	['Enchanted Golden Apple'] = '[&d]Golden Apple',
	['Clay (block)'] = '[Clay]Clay (block)',
	['End Portal (block)'] = '[End Portal]End Portal (block)',
	['Snow (cover)'] = '[Snow]Snow (cover)',

    -- Added for ProjectRed
    ['Any Illumar'] = 'White Illumar; Orange Illumar; Magenta Illumar; Light Blue Illumar; Yellow Illumar; Lime Illumar; Pink Illumar; Grey Illumar; Light Grey Illumar; Cyan Illumar; Purple Illumar; Blue Illumar; Brown Illumar; Green Illumar; Red Illumar; Black Illumar',
    ['Any Lamp'] = 'White Lamp; Orange Lamp; Magenta Lamp; Light Blue Lamp; Yellow Lamp; Lime Lamp; Pink Lamp; Grey Lamp; Light Grey Lamp; Cyan Lamp; Purple Lamp; Blue Lamp; Brown Lamp; Green Lamp; Red Lamp; Black Lamp',
    ['Any Inverted Lamp'] = 'Inverted White Lamp; Inverted Orange Lamp; Inverted Magenta Lamp; Inverted Light Blue Lamp; Inverted Yellow Lamp; Inverted Lime Lamp; Inverted Pink Lamp; Inverted Grey Lamp; Inverted Light Grey Lamp; Inverted Cyan Lamp; Inverted Purple Lamp; Inverted Blue Lamp; Inverted Brown Lamp; Inverted Green Lamp; Inverted Red Lamp; Inverted Black Lamp',
    ['Any Stained Sapling'] = 'White Stained Sapling; Orange Stained Sapling; Magenta Stained Sapling; Light Blue Stained Sapling; Yellow Stained Sapling; Lime Stained Sapling; Pink Stained Sapling; Grey Stained Sapling; Light Grey Stained Sapling; Cyan Stained Sapling; Purple Stained Sapling; Blue Stained Sapling; Brown Stained Sapling; Green Stained Sapling; Red Stained Sapling; Black Stained Sapling',
    ['Any Lantern'] = 'White Lantern; Orange Lantern; Magenta Lantern; Light Blue Lantern; Yellow Lantern; Lime Lantern; Pink Lantern; Grey Lantern; Light Grey Lantern; Cyan Lantern; Purple Lantern; Blue Lantern; Brown Lantern; Green Lantern; Red Lantern; Black Lantern',
    ['Any Inverted Lantern'] = 'Inverted White Lantern; Inverted Orange Lantern; Inverted Magenta Lantern; Inverted Light Blue Lantern; Inverted Yellow Lantern; Inverted Lime Lantern; Inverted Pink Lantern; Inverted Grey Lantern; Inverted Light Grey Lantern; Inverted Cyan Lantern; Inverted Purple Lantern; Inverted Blue Lantern; Inverted Brown Lantern; Inverted Green Lantern; Inverted Red Lantern; Inverted Black Lantern',
    ['Any Illumar Button'] = 'White Illumar Button; Orange Illumar Button; Magenta Illumar Button; Light Blue Illumar Button; Yellow Illumar Button; Lime Illumar Button; Pink Illumar Button; Grey Illumar Button; Light Grey Illumar Button; Cyan Illumar Button; Purple Illumar Button; Blue Illumar Button; Brown Illumar Button; Green Illumar Button; Red Illumar Button; Black Illumar Button',
    ['Any Cage Lamp'] = 'White Cage Lamp; Orange Cage Lamp; Magenta Cage Lamp; Light Blue Cage Lamp; Yellow Cage Lamp; Lime Cage Lamp; Pink Cage Lamp; Grey Cage Lamp; Light Grey Cage Lamp; Cyan Cage Lamp; Purple Cage Lamp; Blue Cage Lamp; Brown Cage Lamp; Green Cage Lamp; Red Cage Lamp; Black Cage Lamp',
    ['Any Inverted Cage Lamp'] = 'Inverted White Cage Lamp; Inverted Orange Cage Lamp; Inverted Magenta Cage Lamp; Inverted Light Blue Cage Lamp; Inverted Yellow Cage Lamp; Inverted Lime Cage Lamp; Inverted Pink Cage Lamp; Inverted Grey Cage Lamp; Inverted Light Grey Cage Lamp; Inverted Cyan Cage Lamp; Inverted Purple Cage Lamp; Inverted Blue Cage Lamp; Inverted Brown Cage Lamp; Inverted Green Cage Lamp; Inverted Red Cage Lamp; Inverted Black Cage Lamp',
    ['Any Fixture'] = 'White Fixture; Orange Fixture; Magenta Fixture; Light Blue Fixture; Yellow Fixture; Lime Fixture; Pink Fixture; Grey Fixture; Light Grey Fixture; Cyan Fixture; Purple Fixture; Blue Fixture; Brown Fixture; Green Fixture; Red Fixture; Black Fixture',
    ['Any Inverted Fixture'] = 'Inverted White Fixture; Inverted Orange Fixture; Inverted Magenta Fixture; Inverted Light Blue Fixture; Inverted Yellow Fixture; Inverted Lime Fixture; Inverted Pink Fixture; Inverted Grey Fixture; Inverted Light Grey Fixture; Inverted Cyan Fixture; Inverted Purple Fixture; Inverted Blue Fixture; Inverted Brown Fixture; Inverted Green Fixture; Inverted Red Fixture; Inverted Black Fixture',
}

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

{{Grid|Any Wood;Golden Apple}}

shows

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

{{Grid|Any Wood,4;[&oShiny Apple]Enchanted Golden Apple}}

shows

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.

{{Grid|Raw Porkchop; Cooked Porkchop|title=Smelly Pork}}

shows

To remove the title, set it to "none": {{Grid|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.

{{Grid|[&e]Enchanted Book}}

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 (/).

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

shows

Align

Align uses the vertical-align CSS property. For example to align to the middle: Smells like {{Grid|Raw Porkchop|align=middle}} in here!

shows

Smells like in here!

Default

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

shows

Link

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

shows

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

shows

Note that this retains the title.

Mods

A mod image is specified with the Mod: section of the name (or by setting a default mod using the mod parameter). The image link will then link to the mod sub-page allowing correct linking of mod images. The uploaded image name should by uploaded as Grid <Name> (<Mod>).png and should be added to the Grid mods category, which prevents them from being confused with official Minecraft items.
For example, to display this mod image File:Grid Bronze Sword (IndustrialCraft).png: {{Grid|IndustrialCraft:Bronze Sword}} (or {{Grid|mod=IndustrialCraft|Bronze Sword}})

shows

Grids can be animated with a theoretically unlimited amount of frames, between mod items and vanilla items. Frames are separated by semi-colons (;).

{{Grid|
Dirt;
TNT,64;
IndustrialCraft:Bronze Sword,6;
;
Grass Block,5;
Sand;
Gold Helmet,12;
IndustrialCraft:Bronze Helmet,2;
IndustrialCraft:Copper,50;
Redstone
}}

shows

64 6
5 12 2 50

As you can see, the mod had to be specified for each mod frame, this is where the default mod parameter is useful. {{Grid|mod=IndustrialCraft|Bronze Sword,6; ; Bronze Helmet,12; Copper,50; Copper Dust}}

shows

6
12 50

To use a vanilla minecraft item when a default mod is set, use "vanilla" (shortcut "v") or "minecraft" (shortcut "mc") as the mod (case insensitive).

{{Grid|mod=IndustrialCraft|
Vanilla:Dirt;
vanilla:TNT,64;
Bronze Sword,6;
;
V:Grass Block,5;
v:Sand;
Minecraft:Gold Helmet,12;
Bronze Helmet,2;
Copper,50;
mc:Redstone Dust
}}

shows

64 6
5 12 2 50

Available images

[edit]

Main article: Template:Grid/Available images

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.