Template:Infobox block/doc: Difference between revisions

From Modded Wiki
Jump to navigation Jump to search
mNo edit summary
m Typo "onlyinclue"
Line 10: Line 10:
This template provides a uniform design for block pages.
This template provides a uniform design for block pages.
<pre width="30px">
<pre width="30px">
&lt;onlyinclue&gt;{{ {{{1|Block}}}
&lt;onlyinclude&gt;{{ {{{1|Block}}}
|image=
|image=
|image2=
|image2=

Revision as of 05:43, 5 April 2011

Template:Doc/start

This is a commonly used and widely-visible template. Do not make significant changes without getting consensus first. 

Template:Block

This template provides a uniform design for block pages.

<onlyinclude>{{ {{{1|Block}}}
|image=
|image2=
|image3=
|invimage=
|invimage2=
|invimage3=
|invimage4=
|type=
|gravity=
|dirt=
|transparent=
|light=
|tntres=
|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
name Only needed to change the name from the page name {{BASEPAGENAME}}
image Image of the block (should be approx. 150x150px) No block image.png
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 (should be approx. 36x36px) None
invimage2 Second image for two-state objects in inventory (should be approx. 36x36px) None
invimage3 Third image for three-state objects in inventory (should be approx. 36x36px) None
invimage4 Fourth image for four-state objects in inventory (should be approx. 36x36px) None
type Type (solid block, solid, block, or fluid) ?
gravity Affected by gravity? ?
dirt Requires sunlight/dirt? None
transparent Can you see through some part of this block? Not as obvious as it seems, see Opacity. ?
light Emits Light? If "Yes," add the light value like this: "Yes, 9" ?
tntres Block's resistance to explosions. The value comes from the code; there aren't any units for it. ?
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

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}} Template:Safe get
{{Safe get|Cobblestone|tool}} Template:Safe get
[[File:{{Safe get|Cobblestone|image}}]] [[File:Template:Safe get]]
{{Safe get|Cobblestone|non-existing field}} Template:Safe get
{{Safe get|Main Page|tntres}} Template:Safe get

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

Minecraft
Minecraft Earth
Minecraft Dungeons
Minecraft Legends
Minecraft Story Mode
Other
Meta

Template:Doc/end