Difference between revisions of "Set location"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
(Created page)
 
imported>StDoodle
(parameter added)
 
(One intermediate revision by one other user not shown)
Line 5: Line 5:
 
FunctionPage|
 
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=Adventuring|
 
  
 
function1={{Function|
 
function1={{Function|
Line 11: Line 10:
 
return_type={{#var:return_type}}|
 
return_type={{#var:return_type}}|
 
return_also={{#var:return_also}}|
 
return_also={{#var:return_also}}|
 +
parameter1={{Param|location|place}}|
 +
p1desc={{Pspan|place}} is the new location|
 
}}|
 
}}|
  
function_description=Changes the value returned by [[my_location|my_location()]]. This is significant because it allows scripts which check current adventuring location to provide results based on the location that you are ''about to'' adventure at.|
+
function_description=Changes the value returned by {{f|my_location}} to {{pspan|place}}. This is significant because it allows scripts which check current adventuring location to provide results based on the location that you are ''about to'' adventure at.|
  
 
needscode=yes|
 
needscode=yes|
Line 19: Line 20:
 
cli_equiv=The CLI command "locations" will list all locations adventured at during your current session, along with adventures spent at each.|
 
cli_equiv=The CLI command "locations" will list all locations adventured at during your current session, along with adventures spent at each.|
 
}}
 
}}
 +
 +
[[Category:Adventuring]]

Latest revision as of 18:25, 31 January 2011

needs(code_samples);

Function Syntax

void set_location(location place )

  • place is the new location

Changes the value returned by my_location() to place. This is significant because it allows scripts which check current adventuring location to provide results based on the location that you are about to adventure at.

CLI Equivalent

The CLI command "locations" will list all locations adventured at during your current session, along with adventures spent at each.

See Also

adventure() | my_location()