Bale: r14389

2014-11-06T08:47:19Z

r14389

New page

{{
#vardefine:name|buy_using_storage}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|it}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type=int|
return_also={{#var:return_also}}|
parameter1={{Param|int|qty}}|
parameter2={{Param|item|it}}|
parameter3={{Param|int|price}}|
p1desc={{pspan|qty}} is the number to purchase|
p2desc={{pspan|it}} is the item to purchase|
p3desc={{pspan|price}} is the (optional) maximum price to spend per item|
}}|

function_description=Using meat in Hangk's Storage the function attempts to mall purchase {{pspan|qty}} amount of item {{pspan|it}}. If {{pspan|qty}} is less than 1, the function will not purchase anything.</p>

<p>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. If a {{pspan|price}} less than 1 is passed, the function will always buy {{pspan|qty}}, regardless of price.</p>

<p>The version that returns a boolean value determine success depending on whether your inventory of the desired item went up by the amount you tried to buy. If {{pspan|qty}} is less than 1, the function will always return true.|

code1={{CodeSample|
title=Code Sample|
description=Pull a quantity of a given item from storage, even if you are in ronin and don't have it in storage.|
code=
<syntaxhighlight>
boolean buy_pull(int quantity, item topull) {
if( in_hardcore() )
print( "You cannot pull items in hardcore.", "red" );
else if(topull == $item[none])
print( "You need to choose a real item to pull.", "red" );
else if(can_interact())
return retrieve_item( quantity, topull );
else if( pulls_remaining() >= quantity ) {
if( storage_amount(topull) < quantity )
buy_using_storage( quantity - storage_amount(topull), topull, get_property("autoBuyPriceLimit").to_int() );
return take_storage(q, topull);
} else
print( ( pulls_remaining() == 0? "No": "Only " + pulls_remaining() ) + " pulls remaining for today.", "red" );
return false;
}
</syntaxhighlight>
}}|

see_also={{SeeAlso|mall_price|buy}}|
cli_equiv=The CLI commands "buy" and "acquire" will purchase items if you are not in ronin or hardcore.|
}}

[[Category:Item Management]]

Buy using storage - Revision history

Bale: r14389