Template:ItemRarity/doc

From Project: Gorgon Wiki
Jump to: navigation, search


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:
    {{ItemRarity|rarity}}
  • Two parameters for use in wikitables, ITEM infoboxes, or other light/dark backgrounds:
    {{ItemRarity|rarity|backgroundShade}}

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

{{ItemRarity|Legendary}}

Example Output 1

Legendary

Example 2: Wikitable

Example Code 2

{| class="wikitable"
!Header
|-
| {{ItemRarity|2|Light}}
|}

Example Output 2

Header
Rare

Example 3: Dark background

Example Code 3

<span style="background-color:#000000>{{ItemRarity|x}}</span>

Example Output 3

Exceptional