Allows to read and write "Player properties" from LocalStorage

front/src/Api/Events/IframeEvent.ts

@@ -28,6 +28,7 @@ import type { MessageReferenceEvent } from "./ui/TriggerActionMessageEvent";
 import { isMessageReferenceEvent, isTriggerActionMessageEvent } from "./ui/TriggerActionMessageEvent";
 import type { MenuRegisterEvent, UnregisterMenuEvent } from "./ui/MenuRegisterEvent";
 import type { ChangeLayerEvent } from "./ChangeLayerEvent";
+import { isPlayerPropertyEvent } from "./PlayerPropertyEvent";
 
 export interface TypedMessageEvent<T> extends MessageEvent {
     data: T;
@@ -59,7 +60,7 @@ export type IframeEventMap = {
     registerMenu: MenuRegisterEvent;
     unregisterMenu: UnregisterMenuEvent;
     setTiles: SetTilesEvent;
-    modifyEmbeddedWebsite: Partial<EmbeddedWebsite>; // Note: name should be compulsory in fact
+    modifyEmbeddedWebsite: Partial<EmbeddedWebsite>; // Note: name should be compulsory in fact;
 };
 export interface IframeEvent<T extends keyof IframeEventMap> {
     type: T;
@@ -149,6 +150,14 @@ export const iframeQueryMapTypeGuards = {
         query: isCreateEmbeddedWebsiteEvent,
         answer: tg.isUndefined,
     },
+    getPlayerProperty: {
+        query: tg.isString,
+        answer: isPlayerPropertyEvent,
+    },
+    setPlayerProperty: {
+        query: isPlayerPropertyEvent,
+        answer: tg.isUndefined,
+    },
 };
 
 type GuardedType<T> = T extends (x: unknown) => x is infer T ? T : never;

front/src/Api/Events/PlayerPropertyEvent.ts

@@ -0,0 +1,13 @@
+import * as tg from "generic-type-guard";
+
+export const isPlayerPropertyEvent = new tg.IsInterface()
+    .withProperties({
+        propertyName: tg.isString,
+        propertyValue: tg.isUnknown,
+    })
+    .get();
+
+/**
+ * A message sent from the iFrame to set player-related properties.
+ */
+export type PlayerPropertyEvent = tg.GuardedType<typeof isPlayerPropertyEvent>;

front/src/Api/iframe/player.ts

@@ -1,8 +1,9 @@
-import { IframeApiContribution, sendToWorkadventure } from "./IframeApiContribution";
+import { IframeApiContribution, queryWorkadventure, sendToWorkadventure } from "./IframeApiContribution";
 import type { HasPlayerMovedEvent, HasPlayerMovedEventCallback } from "../Events/HasPlayerMovedEvent";
 import { Subject } from "rxjs";
 import { apiCallback } from "./registeredCallbacks";
 import { isHasPlayerMovedEvent } from "../Events/HasPlayerMovedEvent";
+import type { PlayerPropertyEvent } from "../Events/PlayerPropertyEvent";
 
 const moveStream = new Subject<HasPlayerMovedEvent>();
 
@@ -67,6 +68,20 @@ export class WorkadventurePlayerCommands extends IframeApiContribution<Workadven
         }
         return uuid;
     }
+
+    getPlayerProperty(name: string): Promise<PlayerPropertyEvent> {
+        return queryWorkadventure({
+            type: "getPlayerProperty",
+            data: name,
+        });
+    }
+
+    setPlayerProperty(property: PlayerPropertyEvent) {
+        queryWorkadventure({
+            type: "setPlayerProperty",
+            data: property,
+        }).catch((e) => console.error(e));
+    }
 }
 
 export default new WorkadventurePlayerCommands();