Difference between revisions of "Take shop"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
(added in r9982)
 
imported>Gnocchi masala
m (Veracity's revision 12905 implementing changed shop funcionality.)
Line 19: Line 19:
 
return_type={{#var:return_type}}|
 
return_type={{#var:return_type}}|
 
return_also={{#var:return_also}}|
 
return_also={{#var:return_also}}|
parameter1={{Param|item|it}}|
+
parameter1={{Param|int|qty}}|
parameter2={{Param|boolean|takeAll}}|
+
parameter2={{Param|item|it}}|
p1desc={{pspan|it}} is the item to take from your mall store|
+
 
p2desc={{pspan|takeAll}} determines if one or all of the specified item will be removed. If this parameter is not used, it will default to true.|
+
p1desc={{pspan|qty}} an optional parameter for the quantity of items to take from your mall store (defaults to all if not provided)|
 +
p2desc={{pspan|it}} is the item to take from your mall store|
 
}}|
 
}}|
  
function_description=This command will remove {{pspan|it}} from your mall store. The 1-parameter version will remove all of the item, so if you only want to remove a single unity, then you will need to use the 2-parameter version with the second parameter set to false.|
+
function_description=This command will remove {{pspan|it}} from your mall store. The 1-parameter version will remove all of the item. If you want to remove less than the maximum amount, then you will need to use the 2-parameter version with the optional first parameter set to the count you wish to remove.|
  
 
needscode=yes|
 
needscode=yes|
  
 
see_also={{SeeAlso|have_shop|put_shop|shop_amount}}|
 
see_also={{SeeAlso|have_shop|put_shop|shop_amount}}|
cli_equiv=The CLI command "shop " works similarly.|
+
cli_equiv=The CLI command "shop take " works similarly.|
 
}}
 
}}
  
 
[[Category:Item Management]]
 
[[Category:Item Management]]

Revision as of 04:35, 30 March 2014

needs(code_samples);

Function Syntax

boolean take_shop(item it )

boolean take_shop(int qty ,item it )

  • qty an optional parameter for the quantity of items to take from your mall store (defaults to all if not provided)
  • it is the item to take from your mall store

This command will remove it from your mall store. The 1-parameter version will remove all of the item. If you want to remove less than the maximum amount, then you will need to use the 2-parameter version with the optional first parameter set to the count you wish to remove.

CLI Equivalent

The CLI command "shop take " works similarly.

See Also

have_shop() | put_shop() | shop_amount()