Mall price: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
← Older edit
VisualWikitext
imported>Slyz
mall-price() does only one mall search per item per session
No edit summary
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{
<onlyinclude>{{{{{format|Function2}}}
#vardefine:name|mall_price}}{{
|name=mall_price
#vardefine:return_type|int}}{{
|function1.return_type=int
|function1.description=Returns the current (lowest) mall price of an item.
|function1.param1=shop_for
|function1.param1.type=item
|function1.param1.description=Item to search for
|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.
|code1={{CodeSample
  |title=Code Samples
  |description=Creates Mae Wests based on your stills remaining. Puts the created items into your shop, pricing them using {{f|mall_price}}.
  |code=
{{{!}} class="wikitable"
! style="width: 45%" {{!}} ASH
! style="width: 55%" {{!}} JavaScript
{{!}}- style="vertical-align: top"
{{!}}
<syntaxhighlight lang="d" line highlight="8">
if ( stills_available() > 1 ) {
  set_property( "promptAboutCrafting", 0 );
  int stills_left = floor( stills_available() / 2 );
  create( stills_left, $item[ Mae West ] );
  print( `Created {stills_left} Mae West.`, "blue" );
  set_property( "promptAboutCrafting", 1 );
  put_shop(
    mall_price( $item[ Mae West ] ),
    0,
    item_amount( $item[ Mae West ] ),
    $item[ Mae West ]
  );
}
</syntaxhighlight>
{{!}}
<syntaxhighlight lang="js" line highlight="18">
const {
  create,
  itemAmount,
  mallPrice,
  print,
  putShop,
  setProperty,
  stillsAvailable,
} = require("kolmafia");


FunctionPage|
const MAE_WEST = Item.get("Mae West");
name={{#var:name}}|
if (stillsAvailable() > 1) {
 
  setProperty("promptAboutCrafting", "0");
function1={{Function|
  let stillsLeft = Math.floor(stillsAvailable() / 2);
name={{#var:name}}|
  create(stillsLeft, MAE_WEST);
aggregate={{#var:aggregate}}|
  print("Created " + stillsLeft + " Mae West.", "blue");
return_type={{#var:return_type}}|
  setProperty("promptAboutCrafting", 1);
return_also={{#var:return_also}}|
  putShop(mallPrice(MAE_WEST), 0, itemAmount(MAE_WEST), MAE_WEST);
parameter1={{Param|item|shop_for}}|
}
p1desc={{Pspan|shop_for}} is the item to inquire on the mall price of|
</syntaxhighlight>
}}|
{{!}}}
 
  |moreinfo=
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.|
 
needscode=yes|
 
see_also={{SeeAlso|historical_price|buy|retrieve_item}}|
cli_equiv=The CLI command "searchmall" also returns current mall prices.|
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.|
}}
}}
 
|see_also={{SeeAlso/Mall Prices}}
|cli_equiv=
|more_info=
|special=
|{{{1|}}}
}}</onlyinclude>
[[Category:Item Management]]
[[Category:Item Management]]

Latest revision as of 15:28, 31 December 2020

Function Syntax

int mall_price( item shop_for )

Returns the current (lowest) mall price of an item.
  • shop_for: Item to search for

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.

Code Samples

Creates Mae Wests based on your stills remaining. Puts the created items into your shop, pricing them using mall_price().

ASH JavaScript 
if ( stills_available() > 1 ) {
   set_property( "promptAboutCrafting", 0 );
   int stills_left = floor( stills_available() / 2 );
   create( stills_left, $item[ Mae West ] );
   print( `Created {stills_left} Mae West.`, "blue" );
   set_property( "promptAboutCrafting", 1 );
   put_shop(
     mall_price( $item[ Mae West ] ), 
     0,
     item_amount( $item[ Mae West ] ),
     $item[ Mae West ]
   );
}

const {
  create,
  itemAmount,
  mallPrice,
  print,
  putShop,
  setProperty,
  stillsAvailable,
} = require("kolmafia");

const MAE_WEST = Item.get("Mae West");
if (stillsAvailable() > 1) {
  setProperty("promptAboutCrafting", "0");
  let stillsLeft = Math.floor(stillsAvailable() / 2);
  create(stillsLeft, MAE_WEST);
  print("Created " + stillsLeft + " Mae West.", "blue");
  setProperty("promptAboutCrafting", 1);
  putShop(mallPrice(MAE_WEST), 0, itemAmount(MAE_WEST), MAE_WEST);
}

See Also

historical_age() | historical_price() | mall_price() | mall_prices()

Retrieved from "https://wiki.kolmafia.us/index.php?title=Mall_price&oldid=8947"