Template:Block/doc

From MC Public Wiki
Jump to navigation Jump to search

{{#vardefine: nodoc | {{{nodoc}}} }}{{#vardefine: baddoc | {{{baddoc}}} }}

Template-info.png Documentation
This is a commonly used and widely-visible template. Do not make changes without getting consensus first.
Block
Type ?
Requirements ?
Physics ?
Transparency ?
Luminance ?
Blast Resistance [edit] ?
Tool ?
Stackable N/A
Speed of fluid movement ?
Speed of walking through ?

This template provides a uniform design for block pages.

<onlyinclude>{{ {{{1|Block}}}
|title=
|image=
|image2=
|image3=
|invimage=
|invimage2=
|invimage3=
|invimage4=
|invimage5=
|invimage6=
|invimage7=
|invimage8=
|invimage9=
|invimage10=
|invimage11=
|invimage12=
|invimage13=
|invimage14=
|invimage15=
|invimage16=
|type=
|gravity=
|dirt=
|transparent=
|light=
|tntres=
|tool=
|stackable=
|data=
|fluidspeed=
|movespeed=
|firstver=
|notes=
}}</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) {{{title}}}.png if it exists, otherwise No block image.png (linking to the page where to upload 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 Template:Grid. Grid {{{title}}}.png if it exists, otherwise None
invimage2 Second image for two-state objects in inventory. Uses Template:Grid. None
invimage3 Third image for three-state objects in inventory. Uses Template:Grid. None
invimage4 Fourth image for four-state objects in inventory. Uses Template:Grid. None
invimage5 Fifth image for five-state objects in inventory. Uses Template:Grid. None
invimage6 Sixth image for six-state objects in inventory. Uses Template:Grid. None
invimage7 Seventh image for seven-state objects in inventory. Uses Template:Grid. None
invimage8 Eighth image for eight-state objects in inventory. Uses Template:Grid. None
invimage9 Ninth image for nine-state objects in inventory. Uses Template:Grid. None
invimage10 Tenth image for ten-state objects in inventory. Uses Template:Grid. None
invimage11 Eleventh image for eleven-state objects in inventory. Uses Template:Grid. None
invimage12 Twelfth image for twelve-state objects in inventory. Uses Template:Grid. None
invimage13 Thirteenth image for thirteen-state objects in inventory. Uses Template:Grid. None
invimage14 Fourteenth image for fourteen-state objects in inventory. Uses Template:Grid. None
invimage15 Fifteenth image for fifteen-state objects in inventory. Uses Template:Grid. None
invimage16 Sixteenth image for sixteen-state objects in inventory. Uses Template:Grid. 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
firstver First version that it was seen in (e.g. Alpha 1.0.17, classic 0.0.23a). None
notes Adds a centred column spanning across both rows at the bottom of the box 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}} tntres}}Expression error: Unrecognized punctuation character "{".
{{Safe get|Cobblestone|tool}} tool}}Expression error: Unrecognized punctuation character "{".
[[File:{{Safe get|Cobblestone|image}}]] [[File:{{#vardefine:Safeget/name|image}}Expression error: Unrecognized punctuation character "{".]]
{{Safe get|Cobblestone|non-existing field}} non-existing field}}Expression error: Unrecognized punctuation character "{".
{{Safe get|Main Page|tntres}} tntres}}Expression error: Unrecognized punctuation character "{".

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

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

fr:Modèle:Bloc/doc