asterobot:movement

asterobot:movement walks the bot's character. Its one function, move(), walks the character to a cell of the map it stands on and resolves once the walk is over. The same call works on a Full socket bot and on a MITM bot (man-in-the-middle: the bot relays the game session of a Dofus client that someone plays).

import { move } from "asterobot:movement";

This is the module's only export.

move()

move(cell, options?) returns Promise<number>.

It resolves with the cell the character stands on, once the server has acknowledged the end of the walk.

try {
  const cell = await move(301);
  botInfo("Standing on cell", cell);
} catch (error) {
  botWarn("Couldn't walk:", String(error));
}

How it walks

1. It reads where the character and the other actors stand, as currentMap() does, and plans the route to cell the way findPath() does, around every other actor. When cell can't be reached, the route ends on the reachable cell closest to it. When there's nowhere to walk, move() resolves right away with the character's cell and sends nothing.
2. It sends MapMovementRequest and waits for the server's MapMovementEvent granting the walk.
3. On a Full socket bot, it waits as long as the Dofus client takes to walk the cells the server granted, then sends MapMovementConfirmRequest. On a MITM bot it sends nothing more: the Dofus client walks the character on screen and confirms the walk itself.
4. It resolves when the server answers with MapMovementConfirmResponse.

When the server grants a shorter walk than the one asked for, move() times the walk the server granted and resolves with the cell where it ends. On a Full socket bot the confirmation leaves as early as a Dofus client could send it. The path explains how that time is found, and why it can be wrong for a mounted character.

One walk at a time

A bot walks one walk at a time, whoever asks for it. While a walk is under way, a second move() rejects at once and sends nothing, and so does a walk started with Walk here on the bot's map in Asteroboard. Await each move() before starting the next.

move() also refuses to start while the character is still walking a walk it didn't ask for, such as one the player started on a MITM bot. That walk counts until the server acknowledges its end, or for one second at most past the time the Dofus client takes to walk it.

The walk belongs to the bot, not to your script. If the script stops during a walk, the promise of move() rejects with the reason the script stopped, and the walk still ends and is confirmed, so the server doesn't keep the character walking.

Doing something else during the walk

move() doesn't hold up the rest of your script. Other code keeps running while the character walks, and on a Full socket bot the confirmation still leaves on time. To send a chat message while walking, start both together:

const [cell] = await Promise.all([
  move(301),
  send("ChatChannelMessageRequest", { channel: "GLOBAL", content: "Hello" }),
]);

Don't keep the promise of move() in a variable to await later. If it rejects before your code reaches the await, nothing catches it and the script stops with unhandled Promise rejection:. Await it, put it in a Promise.all, or give it a .catch().

Until the end of the walk is acknowledged, the server considers the character still walking. Wait for move() to resolve before an action that needs the character standing, such as using an element of the map.

Errors

A mistake in the arguments rejects the promise with a TypeError, and nothing is sent:

A walk that is refused or fails rejects it with an error whose message is one of these texts:

It also rejects with the texts of findPath() when the game data can't be read, such as failed to load map <mapId> for pathfinding: datacenter: no such record: maps/<mapId>. asterobot:pathfinding lists them.

String(error) gives TypeError: or GoError: followed by the text.

Limits

• move() walks on the map the character stands on. It doesn't change maps.
• It's made for moving outside fights, like asterobot:pathfinding.

Walk along a path shows the messages move() exchanges, for a script that walks by hand.