Difference between revisions of "Template:ItemRarity/doc"
From Project: Gorgon Wiki
m |
(→Syntax) |
||
| Line 13: | Line 13: | ||
*Single parameter for use on standard "parchment color" background: <pre>{{ItemRarity|rarity}}</pre> | *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> | *Two parameters for use in wikitables, [[:Template:ITEM_infobox|ITEM infoboxes]], or other light/dark backgrounds: <pre>{{ItemRarity|rarity|backgroundShade}}</pre> | ||
| − | |||
===Parameters=== | ===Parameters=== | ||
| − | *First | + | *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 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 | ** 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) | ** 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. | ** 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 == | == Examples == | ||
Revision as of 09:57, 5 December 2020
Contents
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
| Code | Result |
|---|---|
{{ItemRarity|epic}}
|
Epic |
{{ItemRarity|2}}
|
Rare |
{{ItemRarity|x}}
|
Exceptional |
