Template:Health/doc

[refresh]

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

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

Code	Result
{{hp}}	0HP
{{hp|0}}	0HP
{{hp|4}}	4HP
{{hp|4|total=20}}	4HP
{{hp|7|poisoned=1}}	7HP
{{hp|7|withered=1}}	7HP
{{hp|7|freezing=1}}	7HP
{{hp|7|absorption=1}}	7HP
{{hp|7|hardcore=1}}	7HP
{{hp|7|hardcore=1|poisoned=1}}	7HP
{{hp|7|hardcore=1|withered=1}}	7HP
{{hp|7|hardcore=1|absorption=1}}	7HP
{{hp|7|hardcore=1|freezing=1}}	7HP
{{hp|7|mob=1}}	7HP
{{hp|4|18px}}	4HP
{{hp|20|notag=1}}	HP × 10
{{hp|26|notag=1}}	HP × 13
{{hp|10}}	10HP
{{hp|2.5}}	2.5HP × 1.25
{{hp|41}}	41HP × 20.5
{{hp|4|short=1}}	4HP × 2