Template:GearList/Item/doc: Difference between revisions
From Inkipedia, the Splatoon wiki
GuyPerfect (talk | contribs) (Created page with "__NOTOC__ Displays an item in a Gear list. Intended to be used in conjunction with GearList/Header and Template:GearList/Footer|GearList/Foo...") |
m (added category) |
||
(16 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
Displays an item in a [[Gear]] list. Intended to be used in conjunction with [[Template:GearList/Header|GearList/Header]] and [[Template:GearList/Footer|GearList/Footer]]. | Displays an item in a [[Gear]] list. Intended to be used in conjunction with [[Template:GearList/Header|GearList/Header]] and [[Template:GearList/Footer|GearList/Footer]]. | ||
This template is a proxy that pre-evaluates parameters for [[Template:GearList/ItemEx|GearList/ItemEx]] | |||
== Parameters == | == Parameters == | ||
{| | {| | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<code>game</code>||Optional.||The game the item belongs to. The default value is | |<code>game</code>||Optional.||The game the item belongs to. The default value is <code>Splatoon</code>. Must be one of the following: | ||
*Splatoon | *Splatoon | ||
*Splatoon 2 | *Splatoon 2 | ||
Line 16: | Line 18: | ||
|<code>name</code>|| ||The English name of the item. | |<code>name</code>|| ||The English name of the item. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<code>brand</code>|| ||The English name of the item's [[brand]]. | |<code>euoc</code>||Optional||The Europe/Oceania English name of the item, if different from <code>name</code>. | ||
|- style="vertical-align: top;" | |||
|<code>custom_file</code>||Optional||The name part of the item in its associated file, if different from <code>name</code>. | |||
|- style="vertical-align: top;" | |||
|<code>brand</code>|| ||The English name of the item's [[gear brand]]. | |||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<code>rarity</code>|| ||The | |<code>stars</code><br><code>rarity</code>||Optional.||The [[star power]] of the item. Must be 0, 1, 2 or 3 (matching each game's values). Only one parameter name may be used: <code>stars</code> is preferred, but <code>rarity</code> is kept for existing lists. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<code>ability</code>||Optional.||The primary [[ | |<code>ability</code>||Optional.||The primary [[gear ability]] the item will have when purchased in shops. | ||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<code>amiibo</code>||Optional.||The [[amiibo]] that unlocks the item. Must be one of the following: | |<code>amiibo</code>||Optional.||The [[amiibo]] that unlocks the item. Must be one of the following: | ||
*{{amiibo|Inkling Boy | *{{amiibo|Inkling Boy|icononly}} Inkling Boy | ||
*{{amiibo|Inkling Girl | *{{amiibo|Inkling Girl|icononly}} Inkling Girl | ||
*{{amiibo|Inkling Squid | *{{amiibo|Inkling Squid|icononly}} Inkling Squid | ||
*{{amiibo|Callie | *{{amiibo|Callie|icononly}} Callie | ||
*{{amiibo|Marie | *{{amiibo|Marie|icononly}} Marie | ||
*{{amiibo|Inkling Boy | *{{amiibo|Inkling Boy 2|icononly}} Inkling Boy 2 | ||
*{{amiibo|Inkling Girl | *{{amiibo|Inkling Girl 2|icononly}} Inkling Girl 2 | ||
*{{amiibo|Inkling Squid | *{{amiibo|Inkling Squid 2|icononly}} Inkling Squid 2 | ||
*{{amiibo|Octoling Boy|icononly}} Octoling Boy | |||
*{{amiibo|Octoling Girl|icononly}} Octoling Girl | |||
*{{amiibo|Octoling Octopus|icononly}} Octoling Octopus | |||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<code>availability</code>||Optional.||The special means by which the item can be obtained. Must be one of the following: | |<code>availability</code>||Optional.||The special means by which the item can be obtained. Must be one of the following: | ||
Line 37: | Line 46: | ||
*[[File:S2 Icon Grizzco.png|20px|link=]] Salmon Run | *[[File:S2 Icon Grizzco.png|20px|link=]] Salmon Run | ||
*[[File:Splatfest Logo.png|20px|link=]] [[File:S2 Splatfest Logo.svg|20px|link=]] Splatfest | *[[File:Splatfest Logo.png|20px|link=]] [[File:S2 Splatfest Logo.svg|20px|link=]] Splatfest | ||
*[[File:Octo Expansion Icon.png|20px|link=]] Octo Expansion | |||
|- style="vertical-align: top;" | |||
|<code>cost</code>||Optional.||The numeric amount of currency required to purchase the item from shops. | |||
|- style="vertical-align: top;" | |||
|<code>cost_type</code>||Optional.||The type of currency for <code>cost</code>. Default value is <code>cash</code>. Must be one of the following: | |||
*[[File:S3 Icon Cash.png|20px|link=Cash]] <code>[[cash]]</code> | |||
*[[File:S3 Icon bronze fish scale.png|20px|link=Fish scale]] <code>[[Fish scale|bs]]</code> | |||
*[[File:S3 Icon silver fish scale.png|20px|link=Fish scale]] <code>[[Fish scale|ss]]</code> | |||
*[[File:S3 Icon gold fish scale.png|20px|link=Fish scale]] <code>[[Fish scale|gs]]</code> | |||
|- style="vertical-align: top;" | |||
|<code>addedin</code>||Optional||The [[version]] in which the item was added to the game. | |||
|- style="vertical-align: top;" | |||
|<code>filter_ability</code>||Optional.||No output will be produced if <code>ability</code> and <code>filter_ability</code> don't match. | |||
|- style="vertical-align: top;" | |- style="vertical-align: top;" | ||
|<code> | |<code>filter_brand</code>||Optional.||No output will be produced if <code>brand</code> and <code>filter_brand</code> don't match. | ||
|} | |} | ||
{{GearList/Example}} | {{GearList/Example}} | ||
[[category:Template documentation]] |
Latest revision as of 20:56, 10 May 2024
Displays an item in a Gear list. Intended to be used in conjunction with GearList/Header and GearList/Footer.
This template is a proxy that pre-evaluates parameters for GearList/ItemEx
Parameters
game |
Optional. | The game the item belongs to. The default value is Splatoon . Must be one of the following:
|
category |
The English name of the item's category. Must be one of the following:
| |
name |
The English name of the item. | |
euoc |
Optional | The Europe/Oceania English name of the item, if different from name .
|
custom_file |
Optional | The name part of the item in its associated file, if different from name .
|
brand |
The English name of the item's gear brand. | |
stars rarity |
Optional. | The star power of the item. Must be 0, 1, 2 or 3 (matching each game's values). Only one parameter name may be used: stars is preferred, but rarity is kept for existing lists.
|
ability |
Optional. | The primary gear ability the item will have when purchased in shops. |
amiibo |
Optional. | The amiibo that unlocks the item. Must be one of the following: |
availability |
Optional. | The special means by which the item can be obtained. Must be one of the following:
|
cost |
Optional. | The numeric amount of currency required to purchase the item from shops. |
cost_type |
Optional. | The type of currency for cost . Default value is cash . Must be one of the following:
|
addedin |
Optional | The version in which the item was added to the game. |
filter_ability |
Optional. | No output will be produced if ability and filter_ability don't match.
|
filter_brand |
Optional. | No output will be produced if brand and filter_brand don't match.
|
Example
Markup
{{GearList/Header|Example List|game=Splatoon 2|collapsed=false}} {{GearList/Item|game=Splatoon 2|category=Headgear |name=Armor Helmet Replica|brand=Cuttlegear|amiibo=Marie|ability=Tenacity|stars=3}} {{GearList/Item|game=Splatoon 2|category=Headgear |name=FishFry Visor|brand=Firefin|cost=500|ability=Special Charge Up|stars=1}} {{GearList/Item|game=Splatoon 2|category=Headgear |name=Headlamp Helmet|brand=Grizzco|availability=Salmon Run|stars=3}} {{GearList/Footer}}
Output
Example List
Name | Brand | Availability | Ability | Star power | Added in
| |
---|---|---|---|---|---|---|
Armor Helmet Replica | Cuttlegear | Marie | Tenacity |
| ||
FishFry Visor | Firefin | 500 | Special Charge Up |
| ||
Headlamp Helmet | Grizzco | Salmon Run |