Template:Heart/doc

Documentation

This template displays a HUD heart icon.

Usage

This template is used by entering: Template:Tlx

Parameters

unnamed parameter 1 (optional)

The type of heart.

black
bone	Full bone heart
coin	Full coin heart
red
soul
immoral
morbid
unknown	Full unknown heart

The default value is unknown.

unnamed parameter 2 (optional)

The filling level of the heart.

This has no effect with the unknown heart type.

	black	bone	coin	red	soul	immoral	morbid
empty	(none)	Empty bone heart	Empty coin heart		(none)	(none)	(none)
half		Half bone heart	Half coin heart				(none)
one-thirds	(none)	(none)	(none)	(none)	(none)	(none)
two-thirds	(none)	(none)	(none)	(none)	(none)	(none)
full		Full bone heart	Full coin heart

The default value is full.

unnamed parameter 3 (optional)

An additional layer of the heart.

Allowed values are eternal and gold.

	black	bone	coin	red	soul
empty eternal	(none)	Empty bone heart	(none)	Empty red heart	(none)
half eternal	Half black heart	Half bone heart	(none)	Half red heart	Half soul heart
full eternal	Full black heart	Full bone heart	(none)	Full red heart	Full soul heart
empty gold	(none)	Empty bone heart	(none)	Empty red heart	(none)
half gold	Half black heart	Half bone heart	(none)	Half red heart	Half soul heart
full gold	Full black heart	Full bone heart	(none)	Full red heart	Full soul heart

size (optional)

The size of the icon.

Defaults to 28px.

link (optional)

The on the icon.

Defaults to the heart type page.