View source for Template:Rarity/doc

{{Documentation}}

This template renders a rarity badge. The badge links to the matching tier's row on [[Rarity]].

Rarity data is defined in [[Module:Rarity/Rarity.json]]

== Usage ==
The parameter is case-insensitive.
{|class="wikitable"
|-
! Wikitext
! Output
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Common}}</syntaxhighlight>
| {{Rarity|Common}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Uncommon}}</syntaxhighlight>
| {{Rarity|Uncommon}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Rare}}</syntaxhighlight>
| {{Rarity|Rare}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Super Rare}}</syntaxhighlight>
| {{Rarity|Super Rare}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Ultra Rare}}</syntaxhighlight>
| {{Rarity|Ultra Rare}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Ascendant}}</syntaxhighlight>
| {{Rarity|Ascendant}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Prime}}</syntaxhighlight>
| {{Rarity|Prime}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Mega Prime}}</syntaxhighlight>
| {{Rarity|Mega Prime}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Mystic Prime}}</syntaxhighlight>
| {{Rarity|Mystic Prime}}
|-
| <syntaxhighlight lang="wikitext" inline>{{Rarity|Nebulous}}</syntaxhighlight>
| {{Rarity|Nebulous}}
|}

== TemplateData ==
<templatedata>
{
	"params": {
		"1": {
			"label": "Rarity",
			"type": "string",
			"required": true
		}
	},
	"description": "Renders a rarity badge",
	"format": "inline"
}
</templatedata>

<includeonly>
[[Category:Templates]]
</includeonly>