Template:Health/doc

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

Shortcut

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

This template displays health points and visualizes these with the help of a health bar.

For a more compact display, all health point values above 10 (5 hearts) are replaced by × [hp / 2].

All health point values which are not whole numbers are also replaced by × [hp / 2].

Parameter	Function	Default value
`1`	Amount of hearts to show.	0
`2`	Size of hearts in pixels.	9
`poisoned`	Show yellow-green heart icons.	None
`withered`	Show black withered heart icons.	None
`absorption`	Show absorption heart icons.	None
`freezing`	Show blue freezing heart icons.	None
`hardcore`	Show hardcore heart icon variation.	None
`mob`	Show mob heart icons, aligned to the right.	None
`notag`	Remove number and parenthesis.	None
`short`	Use the shortened format, where one heart is shown with a multiplier.	None
`total`	Total or minimum amount of hearts to show, any more than the set amount in `\|1=` are shown as empty.	0