Buy: Difference between revisions
imported>Bale see also |
imported>Bale http://kolmafia.us/showthread.php?7401&p=56198#post56198 |
||
| Line 40: | Line 40: | ||
function_description=Attempts to purchase {{pspan|qty}} amount of item {{pspan|it}}. If {{pspan|qty}} is less than 1, the function will return true without purchasing anything. If the optional maximum {{pspan|price}} is specified, it returns the integer amount of items purchased; otherwise it returns true if the purchase succeeded and false if it did not. Without the optional {{pspan|price}} parameter, first preference is given to NPC stores when attempting purchases, after which it will attempt to use the mall.</p> | function_description=Attempts to purchase {{pspan|qty}} amount of item {{pspan|it}}. If {{pspan|qty}} is less than 1, the function will return true without purchasing anything. If the optional maximum {{pspan|price}} is specified, it returns the integer amount of items purchased; otherwise it returns true if the purchase succeeded and false if it did not. Without the optional {{pspan|price}} parameter, first preference is given to NPC stores when attempting purchases, after which it will attempt to use the mall.</p> | ||
<p>The versions that return a boolean value determine success depending on whether your inventory of the desired item went up by the amount you tried to buy. If you have clover protection active, that will always fail when you buy ten-leaf clovers - either from the hermit or from the mall.</p> | |||
<p>If a {{pspan|coinmaster}} is listed, it will attempt to purchase from the coinmaster using the correct alternate currency. Otherwise it will be purchased from an NPC store or mall using meat.| | <p>If a {{pspan|coinmaster}} is listed, it will attempt to purchase from the coinmaster using the correct alternate currency. Otherwise it will be purchased from an NPC store or mall using meat.| | ||
Revision as of 06:34, 20 July 2011
Function Syntax
boolean buy(int qty ,item it )
boolean buy(coinmaster master ,int qty ,item it )
int buy(int qty ,item it ,int price )
- qty is the number to purchase
- it is the item to purchase
- price is the (optional) maximum price to spend per item
- master is the coinmaster to purchase from
Attempts to purchase qty amount of item it. If qty is less than 1, the function will return true without purchasing anything. If the optional maximum price is specified, it returns the integer amount of items purchased; otherwise it returns true if the purchase succeeded and false if it did not. Without the optional price parameter, first preference is given to NPC stores when attempting purchases, after which it will attempt to use the mall.
The versions that return a boolean value determine success depending on whether your inventory of the desired item went up by the amount you tried to buy. If you have clover protection active, that will always fail when you buy ten-leaf clovers - either from the hermit or from the mall.
If a coinmaster is listed, it will attempt to purchase from the coinmaster using the correct alternate currency. Otherwise it will be purchased from an NPC store or mall using meat.
Code Sample
Buy a broken skull.
buy(1 , $item[broken skull]);
This expands upon purchasing from a coinmaster to show many related functions.
boolean buy_coinmaster(int qty, item it) {
coinmaster master = to_coinmaster(it.seller);
if(master == $coinmaster[none]) {
print("You do not need a coinmaster to purchase that", "red");
return false;
}
if(!is_accessible(master)) {
print(inaccessible_reason(master), "red");
return false;
}
int coins = master.available_tokens;
int price = buy_price(master, it);
if(price > coins) {
print("You only have "+coins+" "+master.token+", but it costs "+price+" "+master.token, "red");
return false;
}
return buy(master, qty, it);
}CLI Equivalent
The CLI commands "buy" and "acquire" work similarly.