Block/doc

Revision as of 01:35, 1 September 2022

This is the documentation page. It should be transcluded into the main template page. See Template:Documentation for more information

This template uses Module:Infobox, a script written in Lua.

This template provides a uniform design for block pages.

Usage

{{Block
|title=
|image=
|invimage=
|rarity=
|renewable=
|stackable=
|tool=
|tool2=
|tool3=
|tntres=
|hardness=
|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
`invimage`	Image for object in inventory. Can use None to force no invimage. Uses Template:Inventory slot.	None
`invimageN`	Other images for object in inventory. Uses Template:Inventory slot.	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.	?
`hardness`	Block's resistance to being broken. The value comes from the code; there aren't any units for it.	?
`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

Template parameters
This template prefers block formatting of parameters.
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. Example rare	String	optional
Renewability	`renewable`	If this block is renewable or not. Example No Auto value	Boolean	suggested
Stackability	`stackable`	Whether or not this item can be stacked. Example Yes Auto value `No`	Boolean	suggested
Maximum stack size	`maxStack`	The maximum number of items that can be combined into a single stack. Example 64	Number	optional
Tool	`tool`	Tool required to use without destroying the block. Example stone pickaxe	String	suggested
Secondary tool	`tool2`	A secondary tool that can be used. Example hoe	String	optional
TNT resistance	`tntres`	The amount of resistance to explosions this block has. Example 25	Number	suggested
Hardness	`hardness`	The block's resistance to being broken. Example 4	Number	suggested
Emissive	`light`	If this block emits light. Auto value `Yes`	Unknown	optional
Light level	`lightLevel`	The amount of light emitted by this block (1-15), if any. Example 15 Auto value	Number	optional
Transparency	`transparent`	If yes, this block is transparent. Example Yes Auto value `Yes`	Unknown	optional
Flammability	`flammable`	If yes, this block can be lit on fire. Example Yes Auto value `Yes`	Unknown	optional
Lava susceptibility	`lavasusceptible`	If yes, this block can catch fire from nearby lava. Example Yes Auto value `Yes`	Unknown	optional

@@ Line 118: / Line 118: @@
 	"params": {
 		"title": {
-			"aliases": [
-				"name"
-			],
 			"label": "Name",
 			"description": "Name of the block, if different from the page name.",
@@ Line 132: / Line 129: @@
 		},
 		"invimage": {
-			"aliases": [
-				"inventoryImage",
-				"iimage"
-			],
 			"label": "Inventory image",
 			"description": "The image of what the block looks like as an item in the inventory.",
@@ Line 147: / Line 140: @@
 		},
 		"renewable": {
-			"aliases": [
-				"renewability"
-			],
 			"label": "Renewability",
 			"description": "If this block is renewable or not.",
@@ Line 158: / Line 148: @@
 		},
 		"stackable": {
-			"aliases": [
-				"stackability"
-			],
 			"label": "Stackability",
 			"description": "Whether or not this item can be stacked.",
@@ Line 182: / Line 169: @@
 		},
 		"tntres": {
-			"aliases": [
-				"resistance",
-				"tnt",
-				"tntresistance"
-			],
 			"label": "TNT resistance",
 			"description": "The amount of resistance to explosions this block has.",
@@ Line 219: / Line 201: @@
 		},
 		"lavasusceptible": {
-			"aliases": [
-				"lava"
-			],
 			"label": "Lava susceptibility",
 			"description": "If yes, this block can catch fire from nearby lava.",

Block/doc

Revision as of 01:35, 1 September 2022

Usage

Parameters

See also