Template:GearList/Item/doc: Difference between revisions

From Inkipedia, the Splatoon wiki
(added "cost_type" for non-cash currencies (e.g. fish scales))
m (Text replacement - "S3 Icon Bronze Fish Scale.png" to "S3 Icon bronze fish scale.png")
(5 intermediate revisions by 4 users not shown)
Line 20: Line 20:
|<code>euoc</code>||Optional||The Europe/Oceania English name of the item, if different from <code>name</code>.
|<code>euoc</code>||Optional||The Europe/Oceania English name of the item, if different from <code>name</code>.
|- style="vertical-align: top;"
|- style="vertical-align: top;"
|<code>brand</code>|| ||The English name of the item's [[brand]].
|<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>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.
|<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.
Line 50: Line 52:
|<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:
|<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 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 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 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>
*[[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;"
|- 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.
|<code>filter_ability</code>||Optional.||No output will be produced if <code>ability</code> and <code>filter_ability</code> don't match.

Revision as of 17:13, 14 February 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:
  • Splatoon
  • Splatoon 2
category The English name of the item's category. Must be one of the following:
  • Headgear
  • Clothing
  • Shoes
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:
  • Inkling Boy Inkling Boy
  • Inkling Girl Inkling Girl
  • Inkling Squid Inkling Squid
  • Callie Callie
  • Marie Marie
  • Inkling Boy 2 Inkling Boy 2
  • Inkling Girl 2 Inkling Girl 2
  • Inkling Squid 2 Inkling Squid 2
  • Octoling Boy Octoling Boy
  • Octoling Girl Octoling Girl
  • Octoling Octopus Octoling Octopus
availability Optional. The special means by which the item can be obtained. Must be one of the following:
  • S2 Icon Octo Canyon.png Octo Canyon
  • S Icon Octo Valley.png Octo Valley
  • S2 Icon Grizzco.png Salmon Run
  • Splatfest Logo.png S2 Splatfest Logo.svg Splatfest
  • Octo Expansion Icon.png Octo Expansion
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 Armor Helmet Replica Cuttlegear Cuttlegear amiibo Marie Marie S2 Ability Tenacity.png Tenacity Star-full.pngStar-full.pngStar-full.png

FishFry Visor FishFry Visor Firefin Firefin Cash 500 S2 Ability Special Charge Up.png Special Charge Up Star-full.pngStar-empty.pngStar-empty.png

Headlamp Helmet Headlamp Helmet Grizzco Grizzco Salmon Run Salmon Run Star-full.pngStar-full.pngStar-full.png
Retrieved from "https://splatoonwiki.org/w/index.php?title=Template:GearList/Item/doc&oldid=520473"