My location: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m Ah yes; left an extra vardefine; good catch heeheehee
imported>Zarqon
more info
Line 13: Line 13:
}}|
}}|


function_description=Returns the last location your character has adventured at.|
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.|


needscode=yes|
needscode=yes|

Revision as of 13:27, 30 April 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.

Special

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