Difference between pages "Talk:Restore hp" and "Is discardable"

From Kolmafia
(Difference between pages)
Jump to navigation Jump to search
imported>StDoodle
(Created page with "See page for restore_mp() for notes. --~~~~")
 
imported>Bale
m (Bale moved page Is discardable() to Is discardable without leaving a redirect)
 
Line 1: Line 1:
See page for restore_mp() for notes. --[[User:StDoodle|StDoodle (#1059825)]] 12:24, 17 December 2011 (EST)
+
{{
 +
#vardefine:name|is_discardable}}{{
 +
#vardefine:return_type|boolean}}{{
 +
FunctionPage|
 +
name={{#var:name}}|
 +
 
 +
function1={{Function|
 +
name={{#var:name}}|
 +
aggregate={{#var:aggregate}}|
 +
return_type={{#var:return_type}}|
 +
return_also={{#var:return_also}}|
 +
parameter1={{Param|item|check_me}}|
 +
p1desc={{Pspan|check_me}} is an item to test|
 +
}}|
 +
 
 +
function_description=This function check if item can be discarded, returning true if it can other false. Keep in mind it will return true if item can be autosold.|
 +
 
 +
code1={{CodeSample|
 +
title=Code Sample|
 +
description=The following searches all items in inventory and stores any items on display that can be discarded but not autosold (Autosell value is 0).|
 +
code=
 +
<syntaxhighlight>
 +
batch_open();
 +
int[item] inventory = get_inventory() ;
 +
foreach it in inventory
 +
  if ( is_discardable(it) && autosell_price(it) == 0 ){
 +
      put_display( item_amount(it), it );
 +
  }
 +
batch_close();
 +
// We're using a batch here to minimize server hits.
 +
</syntaxhighlight>
 +
}}|
 +
 
 +
see_also={{SeeAlso|use|autosell|is_giftable}}|
 +
}}
 +
 
 +
[[Category:Item Management]]

Latest revision as of 10:28, 21 November 2014

Function Syntax

boolean is_discardable(item check_me )

  • check_me is an item to test

This function check if item can be discarded, returning true if it can other false. Keep in mind it will return true if item can be autosold.

Code Sample

The following searches all items in inventory and stores any items on display that can be discarded but not autosold (Autosell value is 0).

batch_open();
int[item] inventory = get_inventory() ;
foreach it in inventory
   if ( is_discardable(it) && autosell_price(it) == 0 ){
      put_display( item_amount(it), it );
   }
batch_close();
// We're using a batch here to minimize server hits.

See Also

use() | autosell() | is_giftable()