Template:Infobox block/doc: Difference between revisions

From Modded Wiki
Jump to navigation Jump to search
better description
m interwiki JA
 
(71 intermediate revisions by 37 users not shown)
Line 1: Line 1:
{{doc/start}}
{{Documentation header}}
{{msgbox
{{Distinguish|Template:Blocks|Template:Blocked}}
| title = This is a commonly used and widely-visible template. Do not make changes without getting [[Template talk:Block|consensus first]].
| bgcol = #FFCCCC
| linecol = #FFAAAA
}}
{{Block}}


This template provides a uniform design for block pages.
This template provides a uniform design for block pages.
<pre width="30px">
 
== Usage ==
<pre style="display: table;">
{{Block
{{Block
|title=
| title =
|image=
| image =
|image2=
<!-- Start Multiple mode -->
|image3=
| group =  
|invimage=
| 1-1 =  
|invimage2=
| 1-2 =  
|invimage3=
| 1-3 =  
|invimage4=
| group2 =  
|invimage5=
| 2-1 =  
|invimage6=
| 2-2 =  
|invimage7=
| 2-3 =  
|invimage8=
| group3 =  
|invimage9=
| 3-1 =  
|invimage10=
| 3-2 =  
|invimage11=
| 3-3 =  
|invimage12=
| group4 =  
|invimage13=
| 4-1 =  
|invimage14=
| 4-2 =  
|invimage15=
| 4-3 =  
|invimage16=
<!-- End Multiple mode -->
|type=
| rarity =
|gravity=
| renewable =
|dirt=
| stackable =
|transparent=
| tool =
|light=
| tool2 =
|tntres=
| tool3 =
|tool=
| tntres = <!--Typically not used in mainspace articles, as it is loaded from Module:Blast resistance values-->
|renewable=
| hardness = <!--Typically not used in mainspace articles, as it is loaded from Module:Hardness values-->
|stackable=
| durability =
|data=
| light =
|fluidspeed=
| transparent =
|movespeed=
| flammable =
|firstver=
| lavasusceptible =
|notes=
}}</pre>
}}</pre>


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 <code><nowiki>|multipledata=</nowiki></code> instead of <code><nowiki>|data=</nowiki></code>. See below:
=== Parameters ===
 
{| class="wikitable"
{| style="background-color: transparent;"
! 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. 150x150px) || <code><nowiki>{{{title}}}.png</nowiki></code> if it exists, otherwise [[:File:No block image.png|No block image.png]] (linking to the page where to upload the missing image)
| <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>image2</code> || Second image for two-state blocks (also approx. 150x150px) || ''None''
|-
| <code>image3</code> || Third image for three-state blocks (also approx. 150x150px) || ''None''
|-
| <code>invimage</code> || Image for object in inventory. Can use '''None''' to force no invimage.  Uses [[Template:Grid]]. || <code><nowiki>Grid {{{title}}}.png</nowiki></code> if it exists, otherwise ''None''
|-
| <code>invimage2</code> || Second image for two-state objects in inventory. Uses [[Template:Grid]]. || ''None''
|-
|-
| <code>invimage3</code> || Third image for three-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>image''N''</code> || Other images for two-state blocks (also approx. 300×300px) || ''None''
|-
|-
| <code>invimage4</code> || Fourth image for four-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>rarity</code> || The color of this item's name. See [[rarity]] for more info. || ''None''
|-
|-
| <code>invimage5</code> || Fifth image for five-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>renewable</code> || Whether the block is [[Renewable Resource|renewable]] || ?
|-
|-
| <code>invimage6</code> || Sixth image for six-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>stackable</code> || Stackable || ?
|-
|-
| <code>invimage7</code> || Seventh image for seven-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <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>invimage8</code> || Eighth image for eight-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>tool2</code> || Second tool that can be used, same format than the tool field. || ?
|-
|-
| <code>invimage9</code> || Ninth image for nine-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>tool3</code> || Third tool that can be used, same format than the tool field. || ?
|-
|-
| <code>invimage10</code> || Tenth image for ten-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <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>invimage11</code> || Eleventh image for eleven-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <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>invimage12</code> || Twelfth image for twelve-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>durability</code> || Hardness value in ''Minecraft Earth'' || ?
|-
|-
| <code>invimage13</code> || Thirteenth image for thirteen-state objects in inventory. Uses [[Template:Grid]]. || ''None''
| <code>light</code> || Emits Light? If "Yes," add the light value like this: "Yes (9)" || ?
|-
| <code>invimage14</code> || Fourteenth image for fourteen-state objects in inventory. Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage15</code> || Fifteenth image for fifteen-state objects in inventory. Uses [[Template:Grid]]. || ''None''
|-
| <code>invimage16</code> || Sixteenth image for sixteen-state objects in inventory. Uses [[Template:Grid]]. || ''None''
|-
| <code>type</code> || Type (solid block, solid, block, or fluid) || ?
|-
| <code>gravity</code> || Affected by gravity? || ?
|-
| <code>dirt</code> || Requires sunlight/dirt? || ''None''
|-
|-
| <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>light</code> || Emits Light? If "Yes," add the light value like this: "Yes, 9" || ?
| <code>heals</code> || Amount of hunger points restored || ''None''
|-
|-
| <code>tntres</code> || Block's resistance to explosions. The value comes from the code; there aren't any units for it. || ?
| <code>flammable</code> || Whether the block is flammable or not. If so, the flammability value is included. || Unspecified
|-
|-
| <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 the block can be (instantly) broken with any tool. "None" means the block cannot be broken. || ?
| <code>lavasusceptible</code> || Whether the block catches fire from nearby [[lava]]. Not always the same as flammable. || Unspecified
|-
|-
| <code>renewable</code> || Whether the block is [[Renewable Resources|renewable]] || ?
! Parameter (multiple mode only)
! Function
! Default/Example value
|-
|-
| <code>stackable</code> || Stackable || N/A
| {{cd|group}} || Group (tab) under which to put the image || ''None''
|-
|-
| <code>data</code> || Single decimal data value || ''None''
| {{cd|group''N''}} || Other tabs present || ''None''
|-
|-
| <code>multipledata</code> || Multiple decimal data values, use {{tl|dv}} || ''None''
| {{cd|1-''n''}} || ''n''th image under the first (default) tab || ''None''
|-
|-
| <code>fluidspeed</code> || Speed of fluid movement || ''None''
| {{cd|''N''-''n''}} || ''n''th image under the ''N''th tab || ''None''
|-
| <code>movespeed</code> || Speed of walking through || ''None''
|-
| <code>firstver</code> || First version that it was seen in (e.g. Alpha 1.0.17, classic 0.0.23a).  || ''None''
|-
| <code>notes</code> || Adds a centred column spanning across both rows at the bottom of the box || ''None''
|}
|}


== See also ==
== See also ==
{{Infobox see also}}
{{Infobox see also}}
{{doc/end}}<noinclude>
 
<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 is the documentation page. It should be transcluded into Template:Infobox block. See Template:Documentation for more information.
Not to be confused with Template:Blocks or Template:Blocked.

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
Minecraft Earth
Minecraft Dungeons
Minecraft Legends
Minecraft Story Mode
Other
Meta



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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Nametitle

Name of the block, if different from the page name.

Stringoptional
Imageimage

Image of the block. Defaults to using the page name as a filename.

Filesuggested
Inventory imageinvimage

The image of what the block looks like as an item in the inventory.

Fileoptional
Block rarityrarity

The rarity of the block, which will show a special color in chat when in the inventory and in chat.

Example
rare
Stringoptional
Renewabilityrenewable

If this block is renewable or not.

Example
No
Auto value
Booleansuggested
Stackabilitystackable

Whether or not this item can be stacked.

Example
Yes
Auto value
No
Booleansuggested
Maximum stack sizemaxStack

The maximum number of items that can be combined into a single stack.

Example
64
Numberoptional
Tooltool

Tool required to use without destroying the block.

Example
stone pickaxe
Stringsuggested
Secondary tooltool2

A secondary tool that can be used.

Example
hoe
Stringoptional
tool3tool3

no description

Unknownoptional
TNT resistancetntres

The amount of resistance to explosions this block has.

Example
25
Numbersuggested
Hardnesshardness

The block's resistance to being broken.

Example
4
Numbersuggested
Emissivelight

If this block emits light.

Auto value
Yes
Unknownoptional
Light levellightLevel

The amount of light emitted by this block (1-15), if any.

Example
15
Auto value
Numberoptional
Transparencytransparent

If yes, this block is transparent.

Example
Yes
Auto value
Yes
Unknownoptional
waterloggablewaterloggable

no description

Default
If yes, this block can be waterlogged
Example
Yes
Unknownoptional
Durabilitydurability

The block's resistance to being broken (only in Minecraft Earth).

Example
39
Numbersuggested
Flammabilityflammable

If yes, this block can be lit on fire.

Example
Yes
Auto value
Yes
Unknownoptional
Lava susceptibilitylavasusceptible

If yes, this block can catch fire from nearby lava.

Example
Yes
Auto value
Yes
Unknownoptional