Editing Template:Infobox block/doc

{{Documentation header}}
{{Distinguish|Template:Blocked}}
{{lua|Infobox}}
{{Block}}

This template provides a uniform design for block pages.

== Usage ==
<pre style="display: table;">{{Block
|title=
|image=
|invimage=
|rarity=
|renewable=
|stackable=
|tool=
|tool2=
|tool3=
|tntres=
|hardness=
|light=
|transparent=
|flammable=
|lavasusceptible=
}}</pre>

=== Parameters ===
{| class="wikitable"
! Parameter
! Function
! Default value
|-
| <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. 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>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:Inventory slot]]. || ''None''
|-
| <code>invimage''N''</code> || Other images for object in inventory. Uses [[Template:Inventory slot]]. || ''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 Resources|renewable]] || ?
|-
| <code>stackable</code> || Stackable || ?
|-
| <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>tool2</code> || Second tool that can be used, same format than the tool field. || ?
|-
| <code>tool3</code> || Third 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>hardness</code> || Block's resistance to being broken. The value comes from the code; there aren't any units for it. || ?
|-
| <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>heals</code> || Amount of hunger points restored || ''None''
|-
| <code>flammable</code> || Whether the block is flammable or not. If so, the flammability value is included. || Unspecified
|-
| <code>lavasusceptible</code> || Whether the block catches fire from nearby [[lava]]. Not always the same as flammable. || Unspecified
|}

== 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:テンプレート: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]]
[[hu:Sablon:Block/doc]]
[[it:Template:Blocco/doc]]
[[ja:テンプレート: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>
<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"
		},
		"lightLevel": {
			"label": "Light level",
			"description": "The amount of light emitted by this block (1-15), if any.",
			"example": "15",
			"type": "number",
			"autovalue": ""
		}
	},
	"description": "An infobox for a block.",
	"paramOrder": [
		"title",
		"image",
		"invimage",
		"rarity",
		"renewable",
		"stackable",
		"maxStack",
		"tool",
		"tool2",
		"tntres",
		"hardness",
		"light",
		"lightLevel",
		"transparent",
		"flammable",
		"lavasusceptible"
	],
	"format": "block"
}
</templatedata>