Difference between revisions of "Take closet"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
(Created page with '{{#vardefine:name|take_closet}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Item Management| function1={{Function| name={{#var:name…')
 
imported>Bale
(empty_closet)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{#vardefine:name|take_closet}}
+
{{
{{#vardefine:return_type|boolean}}
+
#vardefine:name|take_closet}}{{
 +
#vardefine:return_type|boolean}}{{
  
{{FunctionPage|
+
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=Item Management|
 
  
 
function1={{Function|
 
function1={{Function|
Line 25: Line 25:
 
}}|
 
}}|
  
function_description=Attempts to move {{pspan|qty}} of {{pspan|it}} from your display case to your main inventory. Returns true if the move succeeds and false if it does not. If used without {{pspan|it}} specified, this function will move meat instead of an item.|
+
function_description=Attempts to move {{pspan|qty}} of {{pspan|it}} from your closet to your main inventory. Returns true if the move succeeds and false if it does not. If used without {{pspan|it}} specified, this function will move meat instead of an item.|
  
 
needscode=yes|
 
needscode=yes|
  
see_also={{SeeAlso|put_closet|take_display|take_stash|take_storage}}|
+
see_also={{SeeAlso|put_closet|take_display|take_stash|take_storage|empty_closet}}|
 
cli_equiv=The CLI command "closet" with the parameter "take" works similarly.
 
cli_equiv=The CLI command "closet" with the parameter "take" works similarly.
 
}}
 
}}
 +
 +
[[Category:Item Management]]

Latest revision as of 00:09, 5 November 2014

needs(code_samples);

Function Syntax

boolean take_closet(int qty )

boolean take_closet(int qty ,item it )

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

Attempts to move qty of it from your closet to your main inventory. Returns true if the move succeeds and false if it does not. If used without it specified, this function will move meat instead of an item.

CLI Equivalent

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

See Also

put_closet() | take_display() | take_stash() | take_storage() | empty_closet()