Difference between revisions of "My location"

From Kolmafia
Jump to navigation Jump to search
imported>Zarqon
(more info)
imported>Bale
Line 13: Line 13:
 
}}|
 
}}|
  
function_description=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.|
+
function_description=Returns your current location.  If you are not in combat, this will mostly be the location where you most recently adventured.  However, for a [[Miscellaneous_ASH_Features#Additional_Script_Uses|betweenBattleScript]], it will be the location at which you are ''about to'' adventure.|
 
 
 
needscode=yes|
 
needscode=yes|
  
 +
see_also={{SeeAlso|adventure|set_location}}|
 
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.|
 
special=When not logged in, this function returns $location[none].|
 
special=When not logged in, this function returns $location[none].|
 
}}
 
}}

Revision as of 02:31, 6 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].