From 080d495044e2312779836961b93465c81990d210 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20N=C3=A9grier?= Date: Wed, 21 Jul 2021 16:40:53 +0200 Subject: [PATCH] Renaming `WA.room.getMap` to `WA.room.getTiledMap` --- docs/maps/api-room.md | 6 +++--- front/src/Api/iframe/room.ts | 2 +- maps/tests/Metadata/getCurrentRoom.js | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/maps/api-room.md b/docs/maps/api-room.md index 69d40df9..ca708b29 100644 --- a/docs/maps/api-room.md +++ b/docs/maps/api-room.md @@ -93,7 +93,7 @@ You need to wait for the end of the initialization before accessing `WA.room.id` ```typescript WA.onInit().then(() => { console.log('Room id: ', WA.room.id); - // Will output something like: '/@/myorg/myworld/myroom', or '/_/global/mymap.org/map.json" + // Will output something like: 'https://play.workadventu.re/@/myorg/myworld/myroom', or 'https://play.workadventu.re/_/global/mymap.org/map.json" }) ``` @@ -119,13 +119,13 @@ WA.onInit().then(() => { ### Getting map data ``` -WA.room.getMap(): Promise +WA.room.getTiledMap(): Promise ``` Returns a promise that resolves to the JSON map file. ```javascript -const map = await WA.room.getMap(); +const map = await WA.room.getTiledMap(); console.log("Map generated with Tiled version ", map.tiledversion); ``` diff --git a/front/src/Api/iframe/room.ts b/front/src/Api/iframe/room.ts index bb381601..b5b5c0dd 100644 --- a/front/src/Api/iframe/room.ts +++ b/front/src/Api/iframe/room.ts @@ -79,7 +79,7 @@ export class WorkadventureRoomCommands extends IframeApiContribution { + async getTiledMap(): Promise { const event = await queryWorkadventure({ type: "getMapData", data: undefined }); return event.data as ITiledMap; } diff --git a/maps/tests/Metadata/getCurrentRoom.js b/maps/tests/Metadata/getCurrentRoom.js index 8e90a4ae..df3a995c 100644 --- a/maps/tests/Metadata/getCurrentRoom.js +++ b/maps/tests/Metadata/getCurrentRoom.js @@ -6,6 +6,6 @@ WA.onInit().then(() => { console.log('Player tags: ', WA.player.tags); }); -WA.room.getMap().then((data) => { +WA.room.getTiledMap().then((data) => { console.log('Map data', data); })