My location: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
No edit summary
imported>Bale
mNo edit summary
 
Line 5: Line 5:
FunctionPage|
FunctionPage|
name={{#var:name}}|
name={{#var:name}}|
function_category=Adventuring|


function1={{Function|
function1={{Function|
Line 20: Line 19:
special=When not logged in, this function returns $location[none].|
special=When not logged in, this function returns $location[none].|
}}
}}
[[Category:Adventuring]]

Latest revision as of 22:19, 21 May 2010

needs(code_samples);

Function Syntax

location my_location()

Returns your current location. If you are not in combat, this will mostly be the location where you most recently adventured. However, for a betweenBattleScript, it will be the location at which you are about to adventure.

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() | set_location()

Special

When not logged in, this function returns $location[none].