imported>Alleryn: /* Examples */

2020-12-05T14:01:05Z

Examples

New page

<includeonly>

[[Category:Formatting templates]]
</includeonly><noinclude>

[[Category:Template documentation|{{PAGENAME}}]]
</noinclude>

== Description ==
Outputs a link, formatted into the color of the given rarity, to the page section that describes the rarity tiers of items ([[Items#Item Tiers]]).

== Syntax ==
*Single parameter for use on standard "parchment color" background: <pre>{{ItemRarity|rarity}}</pre>
*Two parameters for use in wikitables, [[:Template:ITEM_infobox|ITEM infoboxes]], or other light/dark backgrounds: <pre>{{ItemRarity|rarity|backgroundShade}}</pre>

===Parameters===
*First parameter (required): The rarity you wish to express. This can be any of:
** The full word description of the rarity: Uncommon, Rare, Exceptional, Epic, Legendary (capitalized or not)
** The number of mods on an item of that rarity: 1, 2, 3, 4, 5
** A one letter abbreviation for that rarity: u, r, x, p, l (capitalized or not)
** Any other values default to "Common" in the color white.
*Second parameter (optional): Used to select a palette with better contrast against the background color. Possible parameters "Light" (or "L") or "Dark" (or "D"), captialized or not. Leave this parameter out for a palette designed for the default "parchment color" wiki background.

== Examples ==
=== Example 1: Directly on the page ===
====Example Code 1====
<pre>{{ItemRarity|Legendary}}</pre>
====Example Output 1====
{{ItemRarity|Legendary}}
===Example 2: Wikitable===
====Example Code 2====
<pre>{| class="wikitable"
!Header
|-
| {{ItemRarity|2|Light}}
|}</pre>
====Example Output 2====
{| class="wikitable"
!Header
|-
| {{ItemRarity|2|Light}}
|}
===Example 3: Dark background===
====Example Code 3====
<pre><span style="background-color:#000000>{{ItemRarity|x}}</span></pre>
====Example Output 3====
<span style="background-color:#000000>{{ItemRarity|x}}</span>

Template:PG/ItemRarity/doc - Revision history

imported>Alleryn: /* Examples */