Take stash: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
Created page with '{{#vardefine:name|take_stash}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Item Management| function1={{Function| name={{#var:name}…'
 
imported>StDoodle
mNo edit summary
Line 1: Line 1:
{{#vardefine:name|take_stash}}
{{
{{#vardefine:return_type|boolean}}
#vardefine:name|take_stash}}{{
#vardefine:return_type|boolean}}{{


{{FunctionPage|
FunctionPage|
name={{#var:name}}|
name={{#var:name}}|
function_category=Item Management|
function_category=Item Management|

Revision as of 21:11, 8 March 2010

needs(code_samples);

Function Syntax

boolean take_stash(int qty ,item it )

  • qty is the quantity to move
  • it is the item to move

Attempts to move qty of it from your clan stash to your main inventory. Returns true if the move succeeds and false if it does not.

CLI Equivalent

The CLI command "stash" with the parameter "take" works similarly.

See Also

put_stash() | refresh_stash() | stash_amount() | take_closet() | take_display() | take_storage()