getLocation
From SmartBots Developers Docs
Revision as of 08:36, 27 February 2025 by Gg (Talk | contribs) (Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Returns current location of the bot bot.</onlyinclude> <syntaxhighlight lang="javascript"> const res = await Bot.getLocation();...")
Returns current location of the bot bot.
const res = await Bot.getLocation();
console.log("Bot location:", res);
Reference
This command accepts the following parameters:
Variable | Required | Description
| |
---|---|---|---|
Input: | |||
Output: | |||
Function returns a Promise with the following data: | |||
success | bool | true if command completed successfully | |
error | string | error string if command has failed | |
online | boolean | Bot online flag | |
region | string | Bot region name | |
position | object | Current bot position, rounded | |
exactPosition | object | Exact bot position (with decimals) |
Details
Command returns bot position, mostly in real-time. Use this command to track actual bot position.
Note: status() command also returns 'location' but it may be cached for up to 30 seconds.
Examples
const loc = await Bot.getLocation();
if(loc.region == "DuoLife") {
console.log("Wow, I'm in SmartBots region now!");
}