Template:MC/Breaking row/doc

Template:Documentation header Template:Lua Template:Uses TemplateStyles This template is used to create a table for the time it takes to mine blocks. The main function is designed for use on Breaking.

Basic usage

Parameters

First column

• Template:P: Block name.
• Template:P: Set the link, defaults to Template:P
• Template:P: Sets the sprite ID, defaults to Template:P
• Template:P: If set, the row uses {{itemSprite}} instead of a {{blockSprite}}.
• Template:P: Used to add a note after the title, usually using <ref>
• Template:P: Trims off the stated text from the end of the title. Designed for use with the horizontal function.

Breaking columns

• Template:P: Proper tool. It can be set to Pickaxe, Axe, Shovel, None, or Any (default).
• Template:P: Minimum grade of tool required. It can be set to Wooden, Stone, Iron, Diamond, or Any (default). Will determine breaking times and when the background turns red.
• Template:P:
  • If set to 0, it changes the background for the columns that should drop to yellow, signifying it does not drop but is the proper tool.
  • If set to 1, the columns will not turn red when below the tool grade. Used because Minecraft Education has blocks that calculate times as if a pickaxe is required (including the no pickaxe penalty), but still drop when broken by hand.
• Template:P: Sets the shears column. If set to 0, it changes the background for the main columns to yellow, signifying it does not drop.
• Template:P: Sets the sword column. If set to 0, it changes the background for the main columns to yellow, signifying it does not drop.

Table parameters

• Template:P: If set, adds the footer. If set to 2, it adds the header columns at the bottom as well.
• Template:P: If set, the table will be sortable.
• Template:P: If set, the main tool column will be removed.
• Template:P: If set, the shears column will be removed.
• Template:P: If set, the sword column will be removed.
• Template:P: If set, the options in horizontal mode will be removed.
• Template:P: If set, the copper row will be removed. Used for April Fools' joke updates through 25w14craftmine, as copper tools do not exist in those versions.
• Template:P: If set, the netherite and copper rows will be removed. Used for April Fools' joke updates through 3D Shareware v1.34, as netherite tools do not exist in those versions.

Multiple names

The parameter Template:P can be a comma separated list to display multiple block names. The first name will be used for the hardness value.

Template:P, Template:P, and Template:P will perform their function on all names in the row if set, unless set to a comma separated list, in which case each part corresponds to the same part of the name, with a part containing only white space setting the name to use the value from Template:P

Modes

The table supports two alternate modes.

Simple

If Template:P is set, the table will not show the "Hardness", "Tool", "Shears", or "Sword" columns. Template:P will also take the function previously done by Template:P.

This mode is designed to be used on tool articles, such as Pickaxe, where the available tool is already stated.

Horizontal

If Template:P is set, the table will rotate, displaying columns of individual blocks instead of rows. In this mode, the entire table is built using a single call of the template. Individual columns are specified using a semi-colon separated list within the parameters. If the corresponding part of the parameter is only white space, the parameter will use the default value.

When using this mode, the parameters Template:P and Template:P have no function, and all parameters that previously affected a column will now affect a row.

This mode is designed for displaying a table on block articles, such as Stone.