Module:Exchange/doc

From Old School RuneScape Wiki
Jump to: navigation, search

This is the documentation page for Module:Exchange

Information icon-grey.svg
This is a documentation subpage for Module:Exchange.
It contains usage information, categories, and other content that is not part of the original module page.

Powers most exchange pages and exchange-related modules and templates.

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

ModuleFunctionTypeUse
Exchange_price(arg)StringGets the current GE price of item named arg
_price(arg, multi, format, round)StringGets the current GE price of item named arg, multiplied by [multi] (default 1), rounded to [round] decimal places (default unrounded), and if [format] is true, formatted with thousands separators (default false)
_value(arg)StringGets the value of item named arg
_highalch(arg)StringGets the high alch value of item named arg, accounting for alch multipliers
_lowalch(arg)StringGets the low alch value of item named arg, accounting for alch multipliers
_alchable(arg)StringGets the alchablility (boolean) of item named arg
_alchmultiplier(arg)StringGets the alchemy multiplier of item named arg (default 0.6)
_limit(arg)StringGets the GE limit of item named arg
_diff(arg, format)StringGets the difference of the current GE price and the previous GE price for item named arg. If format is true, formats the number with thousands separators
_exists(arg)StringChecks if the module for item named arg exists, returns a boolean