Put display: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
mNo edit summary
imported>PhilmASTErpLus
Added code sample
Line 19: Line 19:
function_description=Attempts to move {{pspan|qty}} of {{pspan|it}} to your display case from your main inventory. Returns true if the move succeeds and false if it does not.|
function_description=Attempts to move {{pspan|qty}} of {{pspan|it}} to your display case from your main inventory. Returns true if the move succeeds and false if it does not.|


needscode=yes|
code1={{CodeSample|
title=Code Sample|
description=The following code will put 1 of each Club, Diamond, Heart, and Space necklace into the display case.|
code=
<syntaxhighlight>
foreach necklace in $items[ 1995, 2016, 2017, 2018 ]
{
  if ( item_amount( necklace ) > 0 )
      put_display( 1 , necklace );
  else
      print( "You don't have any " + necklace.to_plural() );
}
</syntaxhighlight>|}}
 


see_also={{SeeAlso|put_closet|put_stash|take_display}}|
see_also={{SeeAlso|put_closet|put_stash|take_display}}|

Revision as of 10:49, 26 June 2010

Function Syntax

boolean put_display(int qty ,item it )

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

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

Code Sample

The following code will put 1 of each Club, Diamond, Heart, and Space necklace into the display case.

foreach necklace in $items[ 1995, 2016, 2017, 2018 ]
{
   if ( item_amount( necklace ) > 0 )
      put_display( 1 , necklace );
   else
      print( "You don't have any " + necklace.to_plural() );
}


see_also=

See Also

put_closet() | put_stash() | take_display()

CLI Equivalent

The CLI command "display" with the parameter "put" works similarly.