Difference between revisions of "Template:Block/doc"
m (1 revision: Blocks system) |
|||
| Line 20: | Line 20: | ||
|invimage4= | |invimage4= | ||
|type= | |type= | ||
|dirt= | |dirt= | ||
| | |maxeu= | ||
| | |storage= | ||
|tool= | |tool= | ||
|stackable= | |stackable= | ||
| Line 61: | Line 59: | ||
| <code>dirt</code> || Requires sunlight/dirt? || ''None'' | | <code>dirt</code> || Requires sunlight/dirt? || ''None'' | ||
|- | |- | ||
| <code> | | <code>maxeu</code> || Maximum operating EU before this block explodes. || | ||
|- | |- | ||
| <code>tool</code> || Tool to use || ? | | <code>tool</code> || Tool to use || ? | ||
Revision as of 21:59, 18 July 2012
| This is a commonly used and widely-visible template. Do not make significant changes without getting consensus first. |
| Block | |
|---|---|
| Properties | |
| Type | ?
|
| Stackable | Yes (64)
|
| Technical Details | |
| First appearance | ? |
|
| |
This template provides a uniform design for block pages.
<onlyinclude>{{ {{{1|Block}}}
|title=
|image=
|image2=
|image3=
|invimage=
|invimage2=
|invimage3=
|invimage4=
|type=
|dirt=
|maxeu=
|storage=
|tool=
|stackable=
|data=
|fluidspeed=
|movespeed=
}}</onlyinclude>
Please note the unusual markup at the beginning and end; copy it verbatim if you are creating a new block page. Also note that if the item has multiple data values, use |multipledata= instead of |data=. See below:
| Parameter | Function | Default value |
|---|---|---|
title |
Only needed to change the title from the page name | {{BASEPAGENAME}}
|
image |
Image of the block (should be approx. 150x150px) | {{BASEPAGENAME}}.png if it exists, otherwise No block image.png (linking to the page where to opload the missing image)
|
image2 |
Second image for two-state blocks (also approx. 150x150px) | None |
image3 |
Third image for three-state blocks (also approx. 150x150px) | None |
invimage |
Image for object in inventory. Can use None to force no invimage. Uses styling and images from Template:Grid/Available images | Grid {{BASEPAGENAME}}.png if it exists, otherwise None
|
invimage2 |
Second image for two-state objects in inventory. Uses styling and images from Template:Grid/Available images | None |
invimage3 |
Third image for three-state objects in inventory. Uses styling and images from Template:Grid/Available images | None |
invimage4 |
Fourth image for four-state objects in inventory. Uses styling and images from Template:Grid/Available images | None |
type |
Type (solid block, solid, block, or fluid) | ? |
gravity |
Affected by gravity? | ? |
dirt |
Requires sunlight/dirt? | None |
maxeu |
Maximum operating EU before this block explodes. | |
tool |
Tool to use | ? |
stackable |
Stackable | N/A |
data |
Single decimal data value | None |
multipledata |
Multiple decimal data values, use {{dv}} |
None |
fluidspeed |
Speed of fluid movement | None |
movespeed |
Speed of walking through | None |
Transcluding block pages[edit]
The unusual header <onlyinclude>{{ {{{1|Block}}} and footer are there so that block pages can be transcluded (used like templates) into other pages. Specifically, this allows the use of {{Safe get}} to get specific data fields out of the infobox header in the block page. Here's some examples:
| Code | Result |
|---|---|
{{Safe get|Cobblestone|tntres}}
|
ERROR: Cobblestone does not properly transclude Template:Block |
{{Safe get|Cobblestone|tool}}
|
ERROR: Cobblestone does not properly transclude Template:Block |
[[File:{{Safe get|Cobblestone|image}}]]
|
[[File:ERROR: Cobblestone does not properly transclude Template:Block]] |
{{Safe get|Cobblestone|non-existing field}}
|
ERROR: Cobblestone does not properly transclude Template:Block |
{{Safe get|Main Page|tntres}}
|
ERROR: Main Page does not properly transclude Template:Block |
Although transcluding non-template pages is somewhat unusual, doing it this way allows all the data properties for a block to be defined in the infobox header, next to each other, and right where most people will think to look for them. At the same time, it allows us to make tables of values for things like Blast Resistance and Hardness that auto-update whenever the main values are changed.
See {{Blast Resistance Table}} for a simple example of how to use this functionality to automatically build tables.
See also[edit]
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.