Mall price: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Slyz
mall-price() does only one mall search per item per session
imported>Bale
more detail on how mall_price value can be updated
Line 15: Line 15:
}}|
}}|


function_description=Returns the current mall price of the given item, ignoring the first five items listed to compensate for stores with limits and min-priced sales. To prevent abuse, this will only perform an actual Mall search once per item per session; subsequent calls for the same item will return a cached value. The cache will be updated after attempts to purchase the item (even unsuccessful ones), but not in any other conditions.|
function_description=Returns the current mall price of the given item, ignoring the first five items listed to compensate for stores with limits and min-priced sales. To prevent abuse, this will only perform an actual Mall search once per item per session; subsequent calls for the same item will return a cached value. The cache will be updated after attempts to purchase the item using the CLI or ASH {{f|buy}} command (even unsuccessful ones), but not in ''any'' other conditions, including purchasing with the purchase tab.|


needscode=yes|
needscode=yes|

Revision as of 23:10, 24 May 2011

needs(code_samples);

Function Syntax

int mall_price(item shop_for )

  • shop_for is the item to inquire on the mall price of

Returns the current mall price of the given item, ignoring the first five items listed to compensate for stores with limits and min-priced sales. To prevent abuse, this will only perform an actual Mall search once per item per session; subsequent calls for the same item will return a cached value. The cache will be updated after attempts to purchase the item using the CLI or ASH buy() command (even unsuccessful ones), but not in any other conditions, including purchasing with the purchase tab.

CLI Equivalent

The CLI command "searchmall" also returns current mall prices.

See Also

historical_price() | buy() | retrieve_item()

Special

Items not listed in the mall will return 0 (untradeable items will return 0 without any server requests). When not logged in, this function returns -1.