Template:Grid/doc: Difference between revisions

Latest revision as of 11:59, 6 November 2023

This is the documentation page, it should be transcluded into the main template page. See Template:Documentation for more information

This template uses Module:Grid, with data stored in Module:Grid/Aliases.
These scripts are written in Lua. Please see wp:Lua and mw:Extension:Scribunto to learn more.

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

Alias	Output
`11 Disc`
`13 Disc`
`Any Carpet`
`Any Colored Dye`
`Any Dye`
`Any Dyed Wool`
`Any Firework Star`
`Any Mushroom`
`Any Quartz Block`
`Any Sandstone`
`Any Stained Clay`
`Any Stained Glass`
`Any Stained Glass Pane`
`Any Stone Bricks`
`Any Stone Slab`
`Any Wood`
`Any Wood Planks`
`Any Wood Slab`
`Any Wood Stairs`
`Any Wool`
`Any fuel`
`Awkward Potion`
`Black Firework Star`
`Blue Firework Star`
`Brown Firework Star`
`Brown Mushroom`
`Brown Mushroom (block)`
`Clay (block)`
`Cyan Firework Star`
`Enchanted Book`
`Enchanted Golden Apple`
`End Portal (block)`
`Golden Apple`
`Gray Firework Star`
`Green Firework Star`
`Light Blue Firework Star`
`Light Gray Firework Star`
`Lime Firework Star`
`Magenta Firework Star`
`Melon (block)`
`Mundane Potion`
`Nether Brick (item)`
`Orange Firework Star`
`Pink Firework Star`
`Purple Firework Star`
`Red Firework Star`
`Red Mushroom`
`Red Mushroom (block)`
`Snow (layer)`
`Stone Button`
`Thick Potion`
`Water Bottle`
`White Firework Star`
`Wooden Button`
`Yellow Firework Star`
`blocks Disc`
`cat Disc`
`chirp Disc`
`far Disc`
`mall Disc`
`mellohi Disc`
`stal Disc`
`strad Disc`
`wait Disc`
`ward Disc`

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.

{{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

444444

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

{{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.

Available images

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.

@@ Line 72: / Line 72: @@
 <code><nowiki>{{Grid|Raw Porkchop; Cooked Porkchop|title=Smelly Pork}}</nowiki></code>
 ;shows
-{{Grid|Raw Porkchop; Cooked Porkchop|title=Smelly Porkchop}}
+{{Grid|Raw Porkchop; Cooked Porkchop|title=Smelly Pork}}