Module:Cost/doc

From Inkipedia, the Splatoon wiki
< Module:Cost
Revision as of 21:34, 22 December 2023 by Slate (talk | contribs) (split from template:Cost)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is the documentation page for Module:Cost

Displays an inline currency icon with a text link.

Usage

{{Cost|<game>|<price>|<currency>|<size>|<link>|<textwidth>}}

game Unnamed, required The game that the cost belongs to. Must be one of the following:
  • S for Splatoon
  • S2 for Splatoon 2
  • S3 for Splatoon 3
price Unnamed, required The number / string to show as the cost.
If set empty, the template will show the icon but no number.
Use 0 or Free for free items.
currency Unnamed, optional The currency to use.
The default value is cash.
Must be one of the following: S S2 S3
cash Cash  Cash  Cash 
pe Power Eggs  Power Eggs  Power Egg Alternas 
sss Super Sea Snails  Super Sea Snails  Super Sea Snails 
ge Golden Eggs  Golden Eggs 
sard Sardinium Shadow  File:S3 Icon Sardinium Shadow.png 
ac Ability Chunks 
cqp CQ Points 
sl Sheldon Licenses 
gsl Gold Sheldon Licenses 
bs Bronze Fish Scales 
ss Silver Fish Scales 
gs Gold Fish Scales 
size Unnamed, optional The icon size for the currency icon. The default is 24.
link Unnamed, optional If present, the amount text will be a link to the currency's page.
textwidth Unnamed, optional Requries size and link to both be present.
If specified, the label will be set inside a right-aligned rectangle of the specified width

Markup

*{{Cost|S|200}}
*{{Cost|S2|200}}
*{{Cost|S3|200}}
*{{Cost|S|}}
*{{Cost|S|1|sss}}
*{{Cost|S2| |ac}}
*{{Cost|S3|160|bs}}
*{{Cost|S|200|cash|48}}
*{{Cost|S|200|cash|link}}
*{{Cost|S|200|cash|48|link}}
*{{Cost|S|200|cash|24|link|60}}
*{{Cost|S|200|cash|24| |60}}

Output

  • Cash 200
  • Cash 200
  • Cash 200
  • Cash
  • Super Sea Snail 1
  • Ability Chunks 
  • Bronze Fish Scales 160
  • Cash 200
  • Cash 200
  • Cash 200
  • Cash 200
  • Cash 200