Difference between revisions of "To location"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
(Created page with '{{ #vardefine:name|to_location}}{{ #vardefine:return_type|location}}{{ FunctionPage| name={{#var:name}}| function_category=Datatype Conversions| function1={{Function| name={{#v…')
 
imported>StDoodle
m
Line 25: Line 25:
 
}}|
 
}}|
  
function_description=Returns the location that matches {{pspan|name}} or {{pspan|id}} as specified. Plural names will not match unless the third form is used and {{pspan|qty}} is not equal to 1.|
+
function_description=Returns the location that matches {{pspan|name}} or {{pspan|id}} as specified.|
  
 
needscode=yes|
 
needscode=yes|
  
special=Unlike direct casting via $item[ ], no match found by this function will return $item[ none ] rather than abort.|
+
special=While direct casting via $location[ ] is case-insensitive and able to catch partial matches, this function has added benefit of handling location ID #'s and passing variables as a string parameter.|
 
}}
 
}}

Revision as of 23:05, 13 March 2010

needs(code_samples);

Function Syntax

location to_location(string name )

  • id is a location name to convert

location to_location(int id )

  • id is a location ID # to convert

Returns the location that matches name or id as specified.

Special

While direct casting via $location[ ] is case-insensitive and able to catch partial matches, this function has added benefit of handling location ID #'s and passing variables as a string parameter.