Module:Currency Image/doc

From RuneRealm Wiki
Jump to navigation Jump to search

This is the documentation page for Module:Currency Image

This is a documentation subpage for Module:Currency Image.
It contains usage information, categories, and other content that is not part of the original module page.
Module:Currency Image is required by Module:Currencies.
Module:Currency Image is required by Module:DropsLine.
Module:Currency Image is required by Module:Sandbox/User:Kelsey/StoreLine.
Module:Currency Image is required by Module:Sandbox/User:PeaceBear0/Store locations list.

This module is a helper module to be used by other modules; it may not designed to be invoked directly. See RuneScape:Lua/Helper modules for a full list and more information.

FunctionTypeUse
(name, quantity)StringIdentifies the proper filename to use for each respective currency type, including if different images apply for differing amounts.

name is the case insensitive currency name.

quantity is a number, or comma-separated string of numbers, the maximum of which will be used.

Supported currency names

abyssal pearls
agility arena ticket
anima-infused bark
archaic emblem
archery ticket
barronite shards
blood money
brimhaven voucher
castle wars ticket
coins
death runes
ecto-tokens
frog token
golden nugget
hallowed mark
league points
mark of grace
mermaid's tear
minnow
molch pearl
numulite
pieces of eight
platinum tokens
shark
speedrun points
stardust
survival tokens
termites
tokkul
trading sticks
twisted league points
unidentified minerals
warrior guild tokens