Template:Grid/doc: Difference between revisions

From Vintage Story Wiki
(basics)
 
(Mark for deletion)
Tag: Replaced
 
Line 1: Line 1:
{{doc/start}}
{{Delete|Leftover doc page of deleted template}}
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 (however Amount, Mod, Link and Title won't do anything without Name):<br>
<pre style="max-width: 484px">{{Grid
|Mod:Name,Amount
|mod=Default mod (useful for animations and layout templates)
|default=Image always shown under the main image
|align=Vertical Alignment
|link=Link override
|title=Title, removes link
|class=Adds additional classes to the .grid class
}}</pre>
 
== Examples ==
To display this image [[:File:Grid Raw Porkchop.png]] with an amount of 20 you would put: <code><nowiki>{{Grid|Raw Porkchop,20}}</nowiki></code>
;shows
{{Grid|Raw Porkchop,20}}
 
An amount of 2 - 999 is supported, anything else will not be displayed. Note, the automatic link is removed if <nowiki>{{SUBPAGENAME}}</nowiki> is the same as the item name. This is to help prevent self-links, use the link parameter to re-add the link if you need it.
 
 
If no image is specified, the background will be added on its own, this could be used to do layouts like so:
<pre style="width:550px">{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}<br>
{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}<br>
{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}<br>
{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}<br>
{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}<br>
{{Grid}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid}}</pre>
;shows
{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}<br>
{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}<br>
{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}<br>
{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}<br>
{{Grid}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid|Gunpowder}}{{Grid}}<br>
{{Grid}}{{Grid|Gunpowder}}{{Grid}}{{Grid}}{{Grid|Gunpowder}}{{Grid}}
 
 
Grids can be animated with a theoretically unlimited amount of frames, between mod items and vanilla items. Frames are separated by semi-colons (;).
<code><nowiki>{{Grid|Dirt;TNT,64;Grass Block,5;Sand;Gold Helmet,12;Redstone}}</nowiki></code>
;shows
{{Grid|Dirt;TNT,64;Grass Block,5;Sand;Gold Helmet,12;Redstone}}
 
 
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 {{Grid|Raw Porkchop|align=middle}} in here!</nowiki></code>
;shows
Smells like {{Grid|Raw Porkchop|align=middle}} in here!
 
 
 
To change the link from the image name put: <code><nowiki>{{Grid|Charcoal|link=Coal#Charcoal}}</nowiki></code>
;shows
{{Grid|Charcoal|link=Coal#Charcoal}}
 
 
To remove the link, set link to none: <code><nowiki>{{Grid|Charcoal|link=none}}</nowiki></code>
;shows
{{Grid|Charcoal|link=none}}
 
Note that this retains the title.
 
 
To add a different title, put: <code><nowiki>{{Grid|Raw Porkchop|title=Smelly Pork}}</nowiki></code>
;shows
{{Grid|Raw Porkchop|title=Smelly Porkchop}}
 
 
To remove the title, set title to none: <code><nowiki>{{Grid|Raw Porkchop|title=none}}</nowiki></code>
;shows
{{Grid|Raw Porkchop|title=none}}
 
Note that setting title will remove the link, due to a limitation in the software.
 
 
== 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.
{{Grid/See also}}
 
{{doc/end}}

Latest revision as of 08:35, 9 December 2023

Delete.png

This template is a candidate for deletion.
Reason: Leftover doc page of deleted template
Before deletion, check what links to this page, the page history, and the page log.
Don't forget to delete this template's documentation if it exists.