9b2914cc63
Allowing loading/saving "metadata" from a room
231 lines
7.3 KiB
TypeScript
231 lines
7.3 KiB
TypeScript
import { registeredCallbacks } from "./Api/iframe/registeredCallbacks";
|
|
import {
|
|
IframeResponseEvent,
|
|
IframeResponseEventMap,
|
|
isIframeAnswerEvent,
|
|
isIframeErrorAnswerEvent,
|
|
isIframeResponseEventWrapper,
|
|
TypedMessageEvent,
|
|
} from "./Api/Events/IframeEvent";
|
|
import chat from "./Api/iframe/chat";
|
|
import type { IframeCallback } from "./Api/iframe/IframeApiContribution";
|
|
import nav from "./Api/iframe/nav";
|
|
import controls from "./Api/iframe/controls";
|
|
import ui from "./Api/iframe/ui";
|
|
import sound from "./Api/iframe/sound";
|
|
import room, { setMapURL, setRoomId } from "./Api/iframe/room";
|
|
import state, { initVariables } from "./Api/iframe/state";
|
|
import player, { setPlayerName, setTags, setUuid } from "./Api/iframe/player";
|
|
import type { ButtonDescriptor } from "./Api/iframe/Ui/ButtonDescriptor";
|
|
import type { Popup } from "./Api/iframe/Ui/Popup";
|
|
import type { Sound } from "./Api/iframe/Sound/Sound";
|
|
import { answerPromises, queryWorkadventure, sendToWorkadventure } from "./Api/iframe/IframeApiContribution";
|
|
|
|
// Notify WorkAdventure that we are ready to receive data
|
|
const initPromise = queryWorkadventure({
|
|
type: "getState",
|
|
data: undefined,
|
|
}).then((state) => {
|
|
setPlayerName(state.nickname);
|
|
setRoomId(state.roomId);
|
|
setMapURL(state.mapUrl);
|
|
setTags(state.tags);
|
|
setUuid(state.uuid);
|
|
initVariables(state.variables as Map<string, unknown>);
|
|
});
|
|
|
|
const wa = {
|
|
ui,
|
|
nav,
|
|
controls,
|
|
chat,
|
|
sound,
|
|
room,
|
|
player,
|
|
state,
|
|
|
|
onInit(): Promise<void> {
|
|
return initPromise;
|
|
},
|
|
|
|
// All methods below are deprecated and should not be used anymore.
|
|
// They are kept here for backward compatibility.
|
|
|
|
/**
|
|
* @deprecated Use WA.chat.sendChatMessage instead
|
|
*/
|
|
sendChatMessage(message: string, author: string): void {
|
|
console.warn("Method WA.sendChatMessage is deprecated. Please use WA.chat.sendChatMessage instead");
|
|
chat.sendChatMessage(message, author);
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.chat.disablePlayerControls instead
|
|
*/
|
|
disablePlayerControls(): void {
|
|
console.warn(
|
|
"Method WA.disablePlayerControls is deprecated. Please use WA.controls.disablePlayerControls instead"
|
|
);
|
|
controls.disablePlayerControls();
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.controls.restorePlayerControls instead
|
|
*/
|
|
restorePlayerControls(): void {
|
|
console.warn(
|
|
"Method WA.restorePlayerControls is deprecated. Please use WA.controls.restorePlayerControls instead"
|
|
);
|
|
controls.restorePlayerControls();
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.ui.displayBubble instead
|
|
*/
|
|
displayBubble(): void {
|
|
console.warn("Method WA.displayBubble is deprecated. Please use WA.ui.displayBubble instead");
|
|
ui.displayBubble();
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.ui.removeBubble instead
|
|
*/
|
|
removeBubble(): void {
|
|
console.warn("Method WA.removeBubble is deprecated. Please use WA.ui.removeBubble instead");
|
|
ui.removeBubble();
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.nav.openTab instead
|
|
*/
|
|
openTab(url: string): void {
|
|
console.warn("Method WA.openTab is deprecated. Please use WA.nav.openTab instead");
|
|
nav.openTab(url);
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.sound.loadSound instead
|
|
*/
|
|
loadSound(url: string): Sound {
|
|
console.warn("Method WA.loadSound is deprecated. Please use WA.sound.loadSound instead");
|
|
return sound.loadSound(url);
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.nav.goToPage instead
|
|
*/
|
|
goToPage(url: string): void {
|
|
console.warn("Method WA.goToPage is deprecated. Please use WA.nav.goToPage instead");
|
|
nav.goToPage(url);
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.nav.goToRoom instead
|
|
*/
|
|
goToRoom(url: string): void {
|
|
console.warn("Method WA.goToRoom is deprecated. Please use WA.nav.goToRoom instead");
|
|
nav.goToRoom(url);
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.nav.openCoWebSite instead
|
|
*/
|
|
openCoWebSite(url: string, allowApi: boolean = false, allowPolicy: string = ""): void {
|
|
console.warn("Method WA.openCoWebSite is deprecated. Please use WA.nav.openCoWebSite instead");
|
|
nav.openCoWebSite(url, allowApi, allowPolicy);
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.nav.closeCoWebSite instead
|
|
*/
|
|
closeCoWebSite(): void {
|
|
console.warn("Method WA.closeCoWebSite is deprecated. Please use WA.nav.closeCoWebSite instead");
|
|
nav.closeCoWebSite();
|
|
},
|
|
|
|
/**
|
|
* @deprecated Use WA.ui.openPopup instead
|
|
*/
|
|
openPopup(targetObject: string, message: string, buttons: ButtonDescriptor[]): Popup {
|
|
console.warn("Method WA.openPopup is deprecated. Please use WA.ui.openPopup instead");
|
|
return ui.openPopup(targetObject, message, buttons);
|
|
},
|
|
/**
|
|
* @deprecated Use WA.chat.onChatMessage instead
|
|
*/
|
|
onChatMessage(callback: (message: string) => void): void {
|
|
console.warn("Method WA.onChatMessage is deprecated. Please use WA.chat.onChatMessage instead");
|
|
chat.onChatMessage(callback);
|
|
},
|
|
/**
|
|
* @deprecated Use WA.room.onEnterZone instead
|
|
*/
|
|
onEnterZone(name: string, callback: () => void): void {
|
|
console.warn("Method WA.onEnterZone is deprecated. Please use WA.room.onEnterZone instead");
|
|
room.onEnterZone(name, callback);
|
|
},
|
|
/**
|
|
* @deprecated Use WA.room.onLeaveZone instead
|
|
*/
|
|
onLeaveZone(name: string, callback: () => void): void {
|
|
console.warn("Method WA.onLeaveZone is deprecated. Please use WA.room.onLeaveZone instead");
|
|
room.onLeaveZone(name, callback);
|
|
},
|
|
};
|
|
|
|
export type WorkAdventureApi = typeof wa;
|
|
|
|
declare global {
|
|
interface Window {
|
|
WA: WorkAdventureApi;
|
|
}
|
|
let WA: WorkAdventureApi;
|
|
}
|
|
|
|
window.WA = wa;
|
|
|
|
window.addEventListener(
|
|
"message",
|
|
<T extends keyof IframeResponseEventMap>(message: TypedMessageEvent<IframeResponseEvent<T>>) => {
|
|
if (message.source !== window.parent) {
|
|
return; // Skip message in this event listener
|
|
}
|
|
const payload = message.data;
|
|
|
|
//console.debug(payload);
|
|
|
|
if (isIframeErrorAnswerEvent(payload)) {
|
|
const queryId = payload.id;
|
|
const payloadError = payload.error;
|
|
|
|
const resolver = answerPromises.get(queryId);
|
|
if (resolver === undefined) {
|
|
throw new Error("In Iframe API, got an error answer for a question that we have no track of.");
|
|
}
|
|
resolver.reject(new Error(payloadError));
|
|
|
|
answerPromises.delete(queryId);
|
|
} else if (isIframeAnswerEvent(payload)) {
|
|
const queryId = payload.id;
|
|
const payloadData = payload.data;
|
|
|
|
const resolver = answerPromises.get(queryId);
|
|
if (resolver === undefined) {
|
|
throw new Error("In Iframe API, got an answer for a question that we have no track of.");
|
|
}
|
|
resolver.resolve(payloadData);
|
|
|
|
answerPromises.delete(queryId);
|
|
} else if (isIframeResponseEventWrapper(payload)) {
|
|
const payloadData = payload.data;
|
|
|
|
const callback = registeredCallbacks[payload.type] as IframeCallback<T> | undefined;
|
|
if (callback?.typeChecker(payloadData)) {
|
|
callback?.callback(payloadData);
|
|
}
|
|
}
|
|
|
|
// ...
|
|
}
|
|
);
|