Template:Infobox block/doc: Difference between revisions

No edit summary
m interwiki JA
 
(30 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{Documentation header}}
{{Documentation header}}
{{lua|Infobox}}
{{Distinguish|Template:Blocks|Template:Blocked}}
{{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 =
|invimage=
<!-- Start Multiple mode -->
|transparent=
| group =
|light=
| 1-1 =
|tntres=
| 1-2 =
|tool=
| 1-3 =
|tool2=
| group2 =
|renewable=
| 2-1 =
|stackable=
| 2-2 =
|flammable=
| 2-3 =  
|lavasusceptible=
| group3 =  
|experience=
| 3-1 =
|drops=
| 3-2 =
|data=
| 3-3 =
|nameid=
| group4 =  
|tags=
| 4-1 =  
|notes=
| 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 =
}}</pre>
}}</pre>


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"
{| class="wikitable"
! Parameter
! Parameter
Line 39: Line 54:
| <code>image''N''</code> || Other images for two-state blocks (also approx. 300×300px) || ''None''
| <code>image''N''</code> || Other images for two-state blocks (also approx. 300×300px) || ''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>rarity</code> || The color of this item's name. See [[rarity]] for more info. || ''None''
|-
| <code>renewable</code> || Whether the block is [[Renewable Resource|renewable]] || ?
|-
|-
| <code>invimage''N''</code> || Other images for object in inventory. Uses [[Template:Grid]]. || ''None''
| <code>stackable</code> || Stackable || ?
|-
|-
| <code>transparent</code> || Can you see through some part of this block? Not as obvious as it seems, see [[Opacity]]. || ?
| <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>light</code> || Emits Light? If "Yes," add the light value like this: "Yes (9)" || ?
| <code>tool2</code> || Second tool that can be used, same format than the tool field. || ?
|-
|-
| <code>tntres</code> || Block's resistance to explosions. The value comes from the code; there aren't any units for it. || ?
| <code>tool3</code> || Third tool that can be used, same format than the tool field. || ?
|-
|-
| <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>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>tool2</code> || Second tool that can be used, same format than the tool field. || ?
| <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>renewable</code> || Whether the block is [[Renewable Resources|renewable]] || ?
| <code>durability</code> || Hardness value in ''Minecraft Earth'' || ?
|-
|-
| <code>stackable</code> || Stackable || N/A
| <code>light</code> || Emits Light? If "Yes," add the light value like this: "Yes (9)" || ?
|-
|-
| <code>flammable</code> || Whether the block is flammable or not. Currently does not record flammability value, however this may be added very soon. || Unspecified
| <code>transparent</code> || Can you see through some part of this block? Not as obvious as it seems, see [[Opacity]]. || ?
|-
|-
| <code>lavasusceptible</code> || Whether the block catches fire from nearby [[lava]]. Not always the same as flammable. || Unspecified
| <code>heals</code> || Amount of hunger points restored || ''None''
|-
|-
| <code>experience</code> || The amount of experience dropped when mined or smelted. May be deprecated soon, see [[Minecraft_Wiki_talk:Community_portal#Handling_loot_tables_on_the_wiki:_a_proposal|here]] for more info. || ''None''
| <code>flammable</code> || Whether the block is flammable or not. If so, the flammability value is included. || Unspecified
|-
|-
| <code>drops</code> || The [[Item (entity)|item entities]] dropped when destroyed. May be deprecated soon, see [[Minecraft_Wiki_talk:Community_portal#Handling_loot_tables_on_the_wiki:_a_proposal|here]] for more info. || Itself
| <code>lavasusceptible</code> || Whether the block catches fire from nearby [[lava]]. Not always the same as flammable. || Unspecified
|-
|-
| <code>data</code> || Single decimal data value || ''None''
! Parameter (multiple mode only)
! Function
! Default/Example value
|-
|-
| <code>multipledata</code> || Multiple decimal data values, use {{tl|dv}} || ''None''
| {{cd|group}} || Group (tab) under which to put the image || ''None''
|-
|-
| <code>nameid</code> || The block's named identifier. Can use '''None''' to force no name ID. || <code>title</code> or <code><nowiki>{{BASEPAGENAME}}</nowiki></code>
| {{cd|group''N''}} || Other tabs present || ''None''
|-
|-
| <code>tags</code> || [[Tag]]s this block is a member of. || ''None''
| {{cd|1-''n''}} || ''n''th image under the first (default) tab || ''None''
|-
|-
| <code>notes</code> || Adds a centred column spanning across both rows at the bottom of the box || ''None''
| {{cd|''N''-''n''}} || ''n''th image under the ''N''th tab || ''None''
|}
|}


Line 81: Line 100:
<includeonly>
<includeonly>
<!-- template categories/interwikis here -->
<!-- template categories/interwikis here -->
[[cs:Šablona:Block]]
[[de:Vorlage:Block]]
[[de:Vorlage:Block]]
[[el:Πρότυπο:Block]]
[[es:Plantilla:Bloque]]
[[es:Plantilla:Bloque]]
[[fr:Modèle:Bloc]]
[[fr:Modèle:Bloc]]
[[hu:Sablon:Block]]
[[it:Template:Blocco]]
[[it:Template:Blocco]]
[[ja:テンプレート:Block]]
[[ja:テンプレート:Infobox block]]
[[ko:틀:Block]]
[[ko:틀:Block]]
[[nl:Sjabloon:Blok]]
[[nl:Sjabloon:Blok]]
[[pl:Szablon:Blok]]
[[pt:Predefinição:Bloco]]
[[pt:Predefinição:Bloco]]
[[ru:Шаблон:Блок]]
[[ru:Шаблон:Блок]]
[[th:แม่แบบ:Block]]
[[tr:Şablon:Block]]
[[uk:Шаблон:Блок]]
[[zh:Template:Block]]
[[zh:Template:Block]]


Line 97: Line 123:
<noinclude>
<noinclude>
<!-- doc categories/interwikis here -->
<!-- doc categories/interwikis here -->
[[cs:Šablona:Block/doc]]
[[de:Vorlage:Block/Dokumentation]]
[[de:Vorlage:Block/Dokumentation]]
[[el:Πρότυπο:Block/doc]]
[[es:Plantilla:Bloque/doc]]
[[es:Plantilla:Bloque/doc]]
[[fr:Modèle:Bloc/doc]]
[[fr:Modèle:Bloc/doc]]
[[hu:Sablon:Block/doc]]
[[it:Template:Blocco/doc]]
[[it:Template:Blocco/doc]]
[[ja:テンプレート:Block/doc]]
[[ja:テンプレート:Infobox block/doc]]
[[ko:틀:Block/doc]]
[[ko:틀:Block/doc]]
[[nl:Sjabloon:Blok/doc]]
[[nl:Sjabloon:Blok/doc]]
[[pl:Szablon:Blok/doc]]
[[pt:Predefinição:Bloco/doc]]
[[pt:Predefinição:Bloco/doc]]
[[ru:Шаблон:Блок/док]]
[[ru:Шаблон:Блок/док]]
[[th:แม่แบบ:Block/doc]]
[[tr:Şablon:Block/doc]]
[[uk:Шаблон:Блок/док]]
[[zh:Template:Block/doc]]
[[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>