To item

From Kolmafia
Revision as of 22:30, 13 March 2010 by imported>StDoodle (Created page with '{{ #vardefine:name|to_item}}{{ #vardefine:return_type|item}}{{ FunctionPage| name={{#var:name}}| function_category=Datatype Conversions| function1={{Function| name={{#var:name}…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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 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.