Difference between revisions of "To item"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
m
imported>PhilmASTErpLus
(E.g. to_item( "120" ) => cog. The same syntax does not work for to_familiar("100"), so I'm guessing it isn't because of automatic type conversion.)
Line 30: Line 30:
 
parameter1={{Param|string|name}}|
 
parameter1={{Param|string|name}}|
 
parameter2={{Param|int|qty}}|
 
parameter2={{Param|int|qty}}|
p1desc={{Pspan|name}} is an item name to convert|
+
p1desc={{Pspan|name}} is an item name or string representation of an item ID # to convert|
 
p2desc={{Pspan|qty}} is an item quantity (acts as a check)
 
p2desc={{Pspan|qty}} is an item quantity (acts as a check)
 
* If {{pspan|qty}} is 1, this function follows normal string matching
 
* If {{pspan|qty}} is 1, this function follows normal string matching

Revision as of 02:40, 26 June 2010

needs(code_samples);

Function Syntax

item to_item(string name )

item to_item(int id )

  • id is an item ID # to convert

item to_item(string name ,int qty )

  • name is an item name or string representation of an item ID # to convert
  • qty is an item quantity (acts as a check)
    • If qty is 1, this function follows normal string matching
    • If qty is any other number, this function will allow plural names to match

Returns the item that matches name or id as specified. Plural names will not match unless the third form is used and qty is not equal to 1.

Special

Unlike direct casting via $item[ ], no match found by this function will return $item[ none ] rather than abort.