Skip to main content

Map Editor API

Currently, the map editor API provides a way to read the areas defined in the map editor and to detect when the user enters or leaves an area. It is "read-only". You cannot modify the map using this API.

We opted for a different approach to the event's detection of 'enter' and 'leave' zones when dealing with an area edited by the map editor.

Detecting when the user enters/leaves an area edited by the map editor​

WA.mapEditor.area.onEnter(name: string): Subscription<{ reason: "initial" | "move" }>
WA.mapEditor.area.onLeave(name: string): Subscription<{ reason: "initial" | "move" }>

Listens to the position of the current user. The event is triggered when the user enters or leaves a given area.

  • name: the name of the area defined in the map editor.

Example:

const myAreaEnterSubscriber = WA.mapEditor.area.onEnter("myAreaName").subscribe(() => {
  WA.chat.sendChatMessage("Hello!", "Mr Robot");
});

const myAreaLeaveSubscriber = WA.mapEditor.area.onLeave("myAreaName").subscribe(() => {
  WA.chat.sendChatMessage("Goodbye!", "Mr Robot");
  myAreaSubscriber.unsubscribe();
});

// If you want to stop listening to the events at some point:
myAreaEnterSubscriber.unsubscribe();
myAreaLeaveSubscriber.unsubscribe();

Note: If the user is already inside the area when the onEnter callback is registered, the callback will fire immediately upon subscription. Similarly, if the user is already outside the area when an onLeave callback is registered, that callback will also fire immediately. If you want to avoid this behavior, you can check the "reason" parameter in the callback, which will be "initial" in this case. If the user enters or leaves the area after the subscription, the "reason" parameter will be "move".

WA.mapEditor.area.onEnter("myAreaName").subscribe(({ reason }) => {
    if (reason === "initial") {
        // The user was already inside the area when the subscription was made.
        return;
    }
    // ...
});

Getting the list of all areas created in the map editor​

WA.mapEditor.area.list(): MapEditorArea[]

Returns the list of all areas created in the map editor.

interface MapEditorArea {
  name: string;
  x: number;
  y: number;
  width: number;
  height: number;
  description: string|undefined;
  searchable: boolean|undefined;
}

Example:

const areas = await WA.mapEditor.area.list();
for (const area of areas) {
  console.log(`Area ${area.name} at (${area.x}, ${area.y}) with width ${area.width} and height ${area.height}`);
}