Difference between pages "Append" and "Take stash"
(Difference between pages)
Jump to navigation
Jump to search
imported>Cheesecookie m (Append returns the result, it does not change the original.) |
imported>StDoodle m |
||
| Line 1: | Line 1: | ||
{{ | {{ | ||
| − | #vardefine:name| | + | #vardefine:name|take_stash}}{{ |
| − | #vardefine:return_type| | + | #vardefine:return_type|boolean}}{{ |
FunctionPage| | FunctionPage| | ||
name={{#var:name}}| | name={{#var:name}}| | ||
| + | function_category=Item Management| | ||
function1={{Function| | function1={{Function| | ||
| Line 11: | Line 12: | ||
return_type={{#var:return_type}}| | return_type={{#var:return_type}}| | ||
return_also={{#var:return_also}}| | return_also={{#var:return_also}}| | ||
| − | parameter1={{Param| | + | parameter1={{Param|int|qty}}| |
| − | parameter2={{Param| | + | parameter2={{Param|item|it}}| |
| − | p1desc={{ | + | p1desc={{pspan|qty}} is the quantity to move| |
| − | p2desc={{ | + | p2desc={{pspan|it}} is the item to move| |
}}| | }}| | ||
| − | function_description= | + | function_description=Attempts to move {{pspan|qty}} of {{pspan|it}} from your clan stash to your main inventory. Returns true if the move succeeds and false if it does not.| |
| − | + | needscode=yes| | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | see_also={{SeeAlso|put_stash|refresh_stash|stash_amount|take_closet|take_display|take_storage}}| | |
| − | + | cli_equiv=The CLI command "stash" with the parameter "take" works similarly. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | see_also={{SeeAlso| | ||
}} | }} | ||
| − | |||
| − | |||
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