Module:Exchange/doc
< Module:Exchange
Jump to navigation
Jump to search
Revision as of 23:39, 4 October 2022 by Jacmob (talk | contribs) (Created page with "{{documentation}} Powers most exchange pages and exchange-related modules and templates. {{Helper module|name=Exchange |fname1=_price(arg) |ftype1=String |fuse1=Gets the current GE price of item named arg |fname2=_price(arg, multi, format, round, default) |ftype2=String |fuse2=Gets 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...")
This is the documentation page for Module:Exchange
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 Near-Reality:Lua/Helper modules for a full list and more information.
Module | Function | Type | Use |
---|---|---|---|
Exchange | _price(arg) | String | Gets the current GE price of item named arg |
_price(arg, multi, format, round, default) | String | Gets 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). If the item does not exist, an error is thrown, unless [default] is set, in which case it will return the given [default] value. | |
_value(arg) | String | Gets the value of item named arg | |
_highalch(arg) | String | Gets the high alch value of item named arg, accounting for alch multipliers | |
_lowalch(arg) | String | Gets the low alch value of item named arg, accounting for alch multipliers | |
_alchable(arg) | String | Gets the alchablility (boolean) of item named arg | |
_alchmultiplier(arg) | String | Gets the alchemy multiplier of item named arg (default 0.6) | |
_limit(arg) | String | Gets the GE limit of item named arg | |
_diff(arg, format) | String | Gets 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) | String | Checks if the module for item named arg exists, returns a boolean |