Template:Infobox block/doc: Difference between revisions
better description |
m interwiki JA |
||
(71 intermediate revisions by 37 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{Documentation header}} | ||
{{ | {{Distinguish|Template:Blocks|Template:Blocked}} | ||
| | |||
This template provides a uniform design for block pages. | This template provides a uniform design for block pages. | ||
<pre | |||
== Usage == | |||
<pre style="display: table;"> | |||
{{Block | {{Block | ||
|title= | | title = | ||
|image= | | image = | ||
| | <!-- Start Multiple mode --> | ||
| | | group = | ||
| | | 1-1 = | ||
| | | 1-2 = | ||
| | | 1-3 = | ||
| | | group2 = | ||
| | | 2-1 = | ||
| | | 2-2 = | ||
| | | 2-3 = | ||
| | | group3 = | ||
| | | 3-1 = | ||
| | | 3-2 = | ||
| | | 3-3 = | ||
| | | group4 = | ||
| | | 4-1 = | ||
| | | 4-2 = | ||
| 4-3 = | |||
| | <!-- End Multiple mode --> | ||
| | | rarity = | ||
| | | renewable = | ||
| | | stackable = | ||
| | | tool = | ||
| | | tool2 = | ||
|tntres= | | tool3 = | ||
| | | tntres = <!--Typically not used in mainspace articles, as it is loaded from Module:Blast resistance values--> | ||
| | | hardness = <!--Typically not used in mainspace articles, as it is loaded from Module:Hardness values--> | ||
| | | durability = | ||
| | | light = | ||
| transparent = | |||
| flammable = | |||
| | | lavasusceptible = | ||
| | |||
}}</pre> | }}</pre> | ||
=== Parameters === | |||
{| class="wikitable" | |||
{| | |||
! Parameter | ! Parameter | ||
! Function | ! Function | ||
Line 55: | Line 50: | ||
| <code>title</code> || Only needed to change the title from the page name || <code><nowiki>{{BASEPAGENAME}}</nowiki></code> | | <code>title</code> || Only needed to change the title from the page name || <code><nowiki>{{BASEPAGENAME}}</nowiki></code> | ||
|- | |- | ||
| <code>image</code> || Image of the block (should be approx. | | <code>image</code> || Image of the block (should be approx. 300×300px) || <code><nowiki>{{{title}}}.png</nowiki></code> if it exists, otherwise [[:File:No image.svg|No image.svg]] (linking to the page where to upload the missing image) | ||
|- | |- | ||
| <code> | | <code>image''N''</code> || Other images for two-state blocks (also approx. 300×300px) || ''None'' | ||
|- | |- | ||
| <code> | | <code>rarity</code> || The color of this item's name. See [[rarity]] for more info. || ''None'' | ||
|- | |- | ||
| <code> | | <code>renewable</code> || Whether the block is [[Renewable Resource|renewable]] || ? | ||
|- | |- | ||
| <code> | | <code>stackable</code> || Stackable || ? | ||
|- | |- | ||
| <code> | | <code>tool</code> || Tool to use. Picture means, the block can only be broken with this tool (this quality or better). Outline means, the block can be broken with any tool, but this tool is the quickest. "Any tool" means that every tool is equally effective (or the block can be instantly broken with anything). "None" means the block cannot be broken. || ? | ||
|- | |- | ||
| <code> | | <code>tool2</code> || Second tool that can be used, same format than the tool field. || ? | ||
|- | |- | ||
| <code> | | <code>tool3</code> || Third tool that can be used, same format than the tool field. || ? | ||
|- | |- | ||
| <code> | | <code>tntres</code> || Block's resistance to explosions. The value comes from the code; there aren't any units for it. The value should normally be defined in [[Module:Blast resistance values]], otherwise, the page may result in an error and be placed in [[:Category:Pages with overridden tntres]]. || ? | ||
|- | |- | ||
| <code> | | <code>hardness</code> || Block's resistance to being broken. The value comes from the code; there aren't any units for it. The value should normally be defined in [[Module:Hardness values]], otherwise, the page may result in an error and be placed in [[:Category:Pages with overridden hardness]]. || ? | ||
|- | |- | ||
| <code> | | <code>durability</code> || Hardness value in ''Minecraft Earth'' || ? | ||
|- | |- | ||
| <code> | | <code>light</code> || Emits Light? If "Yes," add the light value like this: "Yes (9)" || ? | ||
|- | |- | ||
| <code>transparent</code> || Can you see through some part of this block? Not as obvious as it seems, see [[Opacity]]. || ? | | <code>transparent</code> || Can you see through some part of this block? Not as obvious as it seems, see [[Opacity]]. || ? | ||
|- | |- | ||
| <code> | | <code>heals</code> || Amount of hunger points restored || ''None'' | ||
|- | |- | ||
| <code> | | <code>flammable</code> || Whether the block is flammable or not. If so, the flammability value is included. || Unspecified | ||
|- | |- | ||
| <code> | | <code>lavasusceptible</code> || Whether the block catches fire from nearby [[lava]]. Not always the same as flammable. || Unspecified | ||
|- | |- | ||
! Parameter (multiple mode only) | |||
! Function | |||
! Default/Example value | |||
|- | |- | ||
| | | {{cd|group}} || Group (tab) under which to put the image || ''None'' | ||
|- | |- | ||
| | | {{cd|group''N''}} || Other tabs present || ''None'' | ||
|- | |- | ||
| | | {{cd|1-''n''}} || ''n''th image under the first (default) tab || ''None'' | ||
|- | |- | ||
| | | {{cd|''N''-''n''}} || ''n''th image under the ''N''th tab || ''None'' | ||
|} | |} | ||
== See also == | == See also == | ||
{{Infobox see also}} | {{Infobox see also}} | ||
<includeonly> | |||
<!-- template categories/interwikis here --> | |||
[[cs:Šablona:Block]] | |||
[[de:Vorlage:Block]] | |||
[[el:Πρότυπο:Block]] | |||
[[es:Plantilla:Bloque]] | |||
[[fr:Modèle:Bloc]] | |||
[[hu:Sablon:Block]] | |||
[[it:Template:Blocco]] | |||
[[ja:テンプレート:Infobox block]] | |||
[[ko:틀:Block]] | |||
[[nl:Sjabloon:Blok]] | |||
[[pl:Szablon:Blok]] | |||
[[pt:Predefinição:Bloco]] | |||
[[ru:Шаблон:Блок]] | |||
[[th:แม่แบบ:Block]] | |||
[[tr:Şablon:Block]] | |||
[[uk:Шаблон:Блок]] | |||
[[zh:Template:Block]] | |||
[[Category:Infobox templates]] | |||
</includeonly> | |||
<noinclude> | |||
<!-- doc categories/interwikis here --> | |||
[[cs:Šablona:Block/doc]] | |||
[[de:Vorlage:Block/Dokumentation]] | |||
[[el:Πρότυπο:Block/doc]] | |||
[[es:Plantilla:Bloque/doc]] | |||
[[fr:Modèle:Bloc/doc]] | [[fr:Modèle:Bloc/doc]] | ||
[[hu:Sablon:Block/doc]] | |||
[[it:Template:Blocco/doc]] | |||
[[ja:テンプレート:Infobox block/doc]] | |||
[[ko:틀:Block/doc]] | |||
[[nl:Sjabloon:Blok/doc]] | |||
[[pl:Szablon:Blok/doc]] | |||
[[pt:Predefinição:Bloco/doc]] | |||
[[ru:Шаблон:Блок/док]] | |||
[[th:แม่แบบ:Block/doc]] | |||
[[tr:Şablon:Block/doc]] | |||
[[uk:Шаблон:Блок/док]] | |||
[[zh:Template:Block/doc]] | |||
</noinclude> | </noinclude> | ||
<templatedata> | |||
{ | |||
"params": { | |||
"title": { | |||
"label": "Name", | |||
"description": "Name of the block, if different from the page name.", | |||
"type": "string" | |||
}, | |||
"image": { | |||
"label": "Image", | |||
"description": "Image of the block. Defaults to using the page name as a filename.", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | |||
"invimage": { | |||
"label": "Inventory image", | |||
"description": "The image of what the block looks like as an item in the inventory.", | |||
"type": "wiki-file-name" | |||
}, | |||
"rarity": { | |||
"label": "Block rarity", | |||
"description": "The rarity of the block, which will show a special color in chat when in the inventory and in chat.", | |||
"example": "rare", | |||
"type": "string" | |||
}, | |||
"renewable": { | |||
"label": "Renewability", | |||
"description": "If this block is renewable or not.", | |||
"example": "No", | |||
"type": "boolean", | |||
"autovalue": "", | |||
"suggested": true | |||
}, | |||
"stackable": { | |||
"label": "Stackability", | |||
"description": "Whether or not this item can be stacked.", | |||
"example": "Yes", | |||
"type": "boolean", | |||
"autovalue": "No", | |||
"suggested": true | |||
}, | |||
"tool": { | |||
"label": "Tool", | |||
"description": "Tool required to use without destroying the block.", | |||
"example": "stone pickaxe", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"tool2": { | |||
"label": "Secondary tool", | |||
"description": "A secondary tool that can be used.", | |||
"example": "hoe", | |||
"type": "string" | |||
}, | |||
"tntres": { | |||
"label": "TNT resistance", | |||
"description": "The amount of resistance to explosions this block has.", | |||
"example": "25", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"hardness": { | |||
"label": "Hardness", | |||
"description": "The block's resistance to being broken.", | |||
"example": "4", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"light": { | |||
"label": "Emissive", | |||
"description": "If this block emits light.", | |||
"type": "unknown", | |||
"autovalue": "Yes" | |||
}, | |||
"transparent": { | |||
"label": "Transparency", | |||
"description": "If yes, this block is transparent.", | |||
"example": "Yes", | |||
"autovalue": "Yes" | |||
}, | |||
"flammable": { | |||
"label": "Flammability", | |||
"description": "If yes, this block can be lit on fire.", | |||
"example": "Yes", | |||
"autovalue": "Yes" | |||
}, | |||
"lavasusceptible": { | |||
"label": "Lava susceptibility", | |||
"description": "If yes, this block can catch fire from nearby lava.", | |||
"example": "Yes", | |||
"autovalue": "Yes" | |||
}, | |||
"maxStack": { | |||
"label": "Maximum stack size", | |||
"description": "The maximum number of items that can be combined into a single stack.", | |||
"example": "64", | |||
"type": "number" | |||
}, | |||
"durability": { | |||
"label": "Durability", | |||
"description": "The block's resistance to being broken (only in Minecraft Earth).", | |||
"example": "39", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"lightLevel": { | |||
"label": "Light level", | |||
"description": "The amount of light emitted by this block (1-15), if any.", | |||
"example": "15", | |||
"type": "number", | |||
"autovalue": "" | |||
}, | |||
"tool3": {}, | |||
"waterloggable": { | |||
"example": "Yes", | |||
"default": "If yes, this block can be waterlogged" | |||
} | |||
}, | |||
"description": "An infobox for a block.", | |||
"paramOrder": [ | |||
"title", | |||
"image", | |||
"invimage", | |||
"rarity", | |||
"renewable", | |||
"stackable", | |||
"maxStack", | |||
"tool", | |||
"tool2", | |||
"tool3", | |||
"tntres", | |||
"hardness", | |||
"light", | |||
"lightLevel", | |||
"transparent", | |||
"waterloggable", | |||
"durability", | |||
"flammable", | |||
"lavasusceptible" | |||
], | |||
"format": "block" | |||
} | |||
</templatedata> |
Latest revision as of 10:49, 30 June 2024
This template provides a uniform design for block pages.
Usage
{{Block | title = | image = <!-- Start Multiple mode --> | group = | 1-1 = | 1-2 = | 1-3 = | group2 = | 2-1 = | 2-2 = | 2-3 = | group3 = | 3-1 = | 3-2 = | 3-3 = | group4 = | 4-1 = | 4-2 = | 4-3 = <!-- End Multiple mode --> | rarity = | renewable = | stackable = | tool = | tool2 = | tool3 = | tntres = <!--Typically not used in mainspace articles, as it is loaded from Module:Blast resistance values--> | hardness = <!--Typically not used in mainspace articles, as it is loaded from Module:Hardness values--> | durability = | light = | transparent = | flammable = | lavasusceptible = }}
Parameters
Parameter | Function | Default value |
---|---|---|
title |
Only needed to change the title from the page name | {{BASEPAGENAME}}
|
image |
Image of the block (should be approx. 300×300px) | {{{title}}}.png if it exists, otherwise No image.svg (linking to the page where to upload the missing image)
|
imageN |
Other images for two-state blocks (also approx. 300×300px) | None |
rarity |
The color of this item's name. See rarity for more info. | None |
renewable |
Whether the block is renewable | ? |
stackable |
Stackable | ? |
tool |
Tool to use. Picture means, the block can only be broken with this tool (this quality or better). Outline means, the block can be broken with any tool, but this tool is the quickest. "Any tool" means that every tool is equally effective (or the block can be instantly broken with anything). "None" means the block cannot be broken. | ? |
tool2 |
Second tool that can be used, same format than the tool field. | ? |
tool3 |
Third tool that can be used, same format than the tool field. | ? |
tntres |
Block's resistance to explosions. The value comes from the code; there aren't any units for it. The value should normally be defined in Module:Blast resistance values, otherwise, the page may result in an error and be placed in Category:Pages with overridden tntres. | ? |
hardness |
Block's resistance to being broken. The value comes from the code; there aren't any units for it. The value should normally be defined in Module:Hardness values, otherwise, the page may result in an error and be placed in Category:Pages with overridden hardness. | ? |
durability |
Hardness value in Minecraft Earth | ? |
light |
Emits Light? If "Yes," add the light value like this: "Yes (9)" | ? |
transparent |
Can you see through some part of this block? Not as obvious as it seems, see Opacity. | ? |
heals |
Amount of hunger points restored | None |
flammable |
Whether the block is flammable or not. If so, the flammability value is included. | Unspecified |
lavasusceptible |
Whether the block catches fire from nearby lava. Not always the same as flammable. | Unspecified |
Parameter (multiple mode only) | Function | Default/Example value |
group |
Group (tab) under which to put the image | None |
groupN |
Other tabs present | None |
1-n |
nth image under the first (default) tab | None |
N-n |
nth image under the Nth tab | None |
See also
- Minecraft
{{Infobox biome}}
{{Infobox block}}
{{Infobox command}}
{{Infobox development phase}}
{{Infobox enchantment}}
{{Infobox effect}}
{{Infobox entity}}
{{Infobox fluid}}
{{Infobox item}}
{{Infobox item entity}}
{{Infobox structure}}
- Minecraft Earth
- Minecraft Dungeons
{{Infobox Dungeons cosmetic}}
{{Infobox Dungeons enchantment}}
{{Infobox Dungeons entity}}
{{Infobox Dungeons item}}
{{Infobox Dungeons mission}}
- Minecraft Legends
{{Infobox Legends biome}}
{{Infobox Legends entity}}
{{Infobox Legends resource}}
{{Infobox Legends mode}}
{{Infobox Legends skin}}
{{Infobox Legends structure}}
- Minecraft Story Mode
{{Infobox episode}}
- Other
{{Infobox album}}
{{Infobox book}}
{{Infobox board game}}
{{Infobox company}}
{{Fallback infobox}}
{{Infobox guide}}
{{Infobox mash-up}}
{{Infobox music}}
{{Infobox person}}
{{Infobox profile}}
{{Infobox program}}
{{Infobox screen effect}}
{{Infobox server}}
{{Infobox skin pack}}
{{Infobox theme}}
{{Infobox version}}
{{Infobox video}}
{{Infobox website}}
{{Infobox world}}
- Meta
{{Infobox}}
{{Infobox row}}
{{Infobox header}}
- Module:Infobox
cs:Šablona:Block/doc
de:Vorlage:Block/Dokumentation
el:Πρότυπο:Block/doc
es:Plantilla:Bloque/doc
fr:Modèle:Bloc/doc
hu:Sablon:Block/doc
it:Template:Blocco/doc
ja:テンプレート:Infobox block/doc
ko:틀:Block/doc
nl:Sjabloon:Blok/doc
pl:Szablon:Blok/doc
pt:Predefinição:Bloco/doc
ru:Шаблон:Блок/док
th:แม่แบบ:Block/doc
tr:Şablon:Block/doc
uk:Шаблон:Блок/док
zh:Template:Block/doc
An infobox for a block.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | title | Name of the block, if different from the page name. | String | optional |
Image | image | Image of the block. Defaults to using the page name as a filename. | File | suggested |
Inventory image | invimage | The image of what the block looks like as an item in the inventory. | File | optional |
Block rarity | rarity | The rarity of the block, which will show a special color in chat when in the inventory and in chat.
| String | optional |
Renewability | renewable | If this block is renewable or not.
| Boolean | suggested |
Stackability | stackable | Whether or not this item can be stacked.
| Boolean | suggested |
Maximum stack size | maxStack | The maximum number of items that can be combined into a single stack.
| Number | optional |
Tool | tool | Tool required to use without destroying the block.
| String | suggested |
Secondary tool | tool2 | A secondary tool that can be used.
| String | optional |
tool3 | tool3 | no description | Unknown | optional |
TNT resistance | tntres | The amount of resistance to explosions this block has.
| Number | suggested |
Hardness | hardness | The block's resistance to being broken.
| Number | suggested |
Emissive | light | If this block emits light.
| Unknown | optional |
Light level | lightLevel | The amount of light emitted by this block (1-15), if any.
| Number | optional |
Transparency | transparent | If yes, this block is transparent.
| Unknown | optional |
waterloggable | waterloggable | no description
| Unknown | optional |
Durability | durability | The block's resistance to being broken (only in Minecraft Earth).
| Number | suggested |
Flammability | flammable | If yes, this block can be lit on fire.
| Unknown | optional |
Lava susceptibility | lavasusceptible | If yes, this block can catch fire from nearby lava.
| Unknown | optional |