Difference between revisions of "Bot Playground/Commands/getLocation"

Revision as of 09:41, 27 February 2025

Returns current location of the bot bot.

const res = await Bot.getLocation();
console.log("Bot location:", res);

Reference

This command accepts the following parameters:

{
  x: number; // 100
  y: number; // 110
  z: number; // 20
}

{
  x: number; // 100.01
  y: number; // 109.65
  z: number; // 20.4
}

Details

Command returns bot position, mostly in real-time. Use this command to track actual bot position.

Note: Bot.status() command also returns 'location' but it may be cached for up to 30 seconds.

'position' is just a rounded copy of 'exactPosition'. It has been added for convenience, to avoid clogging code with *Math.round* calls.

Calling when offline

If _getLocation()_ is being called when bot is offline, then 'online' flag is false, and all other fields are _null_.

Examples

const loc = await Bot.getLocation();
if(loc.region == "DuoLife") {
  console.log("Wow, I'm in SmartBots region now!");
  console.log(loc);
}

Example output:

{
   "online":true,
   "region":"DuoLife",
   "position":{
      "x":230,
      "y":78,
      "z":32
   },
   "exactPosition":{
      "x":229.6,
      "y":77.69,
      "z":32.1
   }
}