My location: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle Created page with '{{ #vardefine:name|my_location}}{{ #vardefine:return_type|location}}{{ #vardefine:aggregate|yes}}{{ #vardefine:return_also|buffer}}{{ FunctionPage| name={{#var:name}}| function_…' |
imported>Bale mNo edit summary |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
#vardefine:name|my_location}}{{ | #vardefine:name|my_location}}{{ | ||
#vardefine:return_type|location}}{{ | #vardefine:return_type|location}}{{ | ||
FunctionPage| | FunctionPage| | ||
name={{#var:name}}| | name={{#var:name}}| | ||
function1={{Function| | function1={{Function| | ||
name={{#var:name}}| | name={{#var:name}}| | ||
return_type={{#var:return_type}}| | return_type={{#var:return_type}}| | ||
return_also={{#var:return_also}}| | return_also={{#var:return_also}}| | ||
}}| | }}| | ||
function_description=Returns the | 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].| | ||
}} | }} | ||
[[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
Special
When not logged in, this function returns $location[none].