Merge pull request #1406 from thecodingmachine/fix/recursive_variables

Allowing variables nested in group layers

back/package.json

@@ -40,7 +40,7 @@
   },
   "homepage": "https://github.com/thecodingmachine/workadventure#readme",
   "dependencies": {
-    "@workadventure/tiled-map-type-guard": "^1.0.0",
+    "@workadventure/tiled-map-type-guard": "^1.0.2",
     "axios": "^0.21.1",
     "busboy": "^0.3.1",
     "circular-json": "^0.5.9",

back/src/Services/VariablesManager.ts

@@ -1,7 +1,12 @@
 /**
  * Handles variables shared between the scripting API and the server.
  */
-import { ITiledMap, ITiledMapObject, ITiledMapObjectLayer } from "@workadventure/tiled-map-type-guard/dist";
+import {
+    ITiledMap,
+    ITiledMapLayer,
+    ITiledMapObject,
+    ITiledMapObjectLayer,
+} from "@workadventure/tiled-map-type-guard/dist";
 import { User } from "_Model/User";
 import { variablesRepository } from "./Repository/VariablesRepository";
 import { redisClient } from "./RedisClient";
@@ -83,25 +88,33 @@ export class VariablesManager {
     private static findVariablesInMap(map: ITiledMap): Map<string, Variable> {
         const objects = new Map<string, Variable>();
         for (const layer of map.layers) {
-            if (layer.type === "objectgroup") {
+            this.recursiveFindVariablesInLayer(layer, objects);
-                for (const object of (layer as ITiledMapObjectLayer).objects) {
-                    if (object.type === "variable") {
-                        if (object.template) {
-                            console.warn(
-                                'Warning, a variable object is using a Tiled "template". WorkAdventure does not support objects generated from Tiled templates.'
-                            );
-                            continue;
-                        }
-
-                        // We store a copy of the object (to make it immutable)
-                        objects.set(object.name, this.iTiledObjectToVariable(object));
-                    }
-                }
-            }
         }
         return objects;
     }
 
+    private static recursiveFindVariablesInLayer(layer: ITiledMapLayer, objects: Map<string, Variable>): void {
+        if (layer.type === "objectgroup") {
+            for (const object of layer.objects) {
+                if (object.type === "variable") {
+                    if (object.template) {
+                        console.warn(
+                            'Warning, a variable object is using a Tiled "template". WorkAdventure does not support objects generated from Tiled templates.'
+                        );
+                        continue;
+                    }
+
+                    // We store a copy of the object (to make it immutable)
+                    objects.set(object.name, this.iTiledObjectToVariable(object));
+                }
+            }
+        } else if (layer.type === "group") {
+            for (const innerLayer of layer.layers) {
+                this.recursiveFindVariablesInLayer(innerLayer, objects);
+            }
+        }
+    }
+
     private static iTiledObjectToVariable(object: ITiledMapObject): Variable {
         const variable: Variable = {};
 

back/yarn.lock

@@ -194,10 +194,10 @@
     semver "^7.3.2"
     tsutils "^3.17.1"
 
-"@workadventure/tiled-map-type-guard@^1.0.0":
+"@workadventure/tiled-map-type-guard@^1.0.2":
-  version "1.0.0"
+  version "1.0.2"
-  resolved "https://registry.yarnpkg.com/@workadventure/tiled-map-type-guard/-/tiled-map-type-guard-1.0.0.tgz#02524602ee8b2688429a1f56df1d04da3fc171ba"
+  resolved "https://registry.yarnpkg.com/@workadventure/tiled-map-type-guard/-/tiled-map-type-guard-1.0.2.tgz#4171550f6cd71be19791faef48360d65d698bcb0"
-  integrity sha512-Mc0SE128otQnYlScQWVaQVyu1+CkailU/FTBh09UTrVnBAhyMO+jIn9vT9+Dv244xq+uzgQDpXmiVdjgrYFQ+A==
+  integrity sha512-RCtygGV5y9cb7QoyGMINBE9arM5pyXjkxvXgA5uXEv4GDbXKorhFim/rHgwbVR+eFnVF3rDgWbRnk3DIaHt+lQ==
   dependencies:
     generic-type-guard "^3.4.1"
 

front/src/Phaser/Game/SharedVariablesManager.ts

@@ -1,10 +1,7 @@
 import type { RoomConnection } from "../../Connexion/RoomConnection";
 import { iframeListener } from "../../Api/IframeListener";
-import type { Subscription } from "rxjs";
 import type { GameMap } from "./GameMap";
-import type { ITile, ITiledMapObject } from "../Map/ITiledMap";
+import type {ITiledMapLayer, ITiledMapObject, ITiledMapObjectLayer} from "../Map/ITiledMap";
-import type { Var } from "svelte/types/compiler/interfaces";
-import { init } from "svelte/internal";
 
 interface Variable {
     defaultValue: unknown;
@@ -100,24 +97,33 @@ export class SharedVariablesManager {
     private static findVariablesInMap(gameMap: GameMap): Map<string, Variable> {
         const objects = new Map<string, Variable>();
         for (const layer of gameMap.getMap().layers) {
-            if (layer.type === "objectgroup") {
+            this.recursiveFindVariablesInLayer(layer, objects);
-                for (const object of layer.objects) {
-                    if (object.type === "variable") {
-                        if (object.template) {
-                            console.warn(
-                                'Warning, a variable object is using a Tiled "template". WorkAdventure does not support objects generated from Tiled templates.'
-                            );
-                        }
-
-                        // We store a copy of the object (to make it immutable)
-                        objects.set(object.name, this.iTiledObjectToVariable(object));
-                    }
-                }
-            }
         }
         return objects;
     }
 
+    private static recursiveFindVariablesInLayer(layer: ITiledMapLayer, objects: Map<string, Variable>): void {
+        if (layer.type === "objectgroup") {
+            for (const object of layer.objects) {
+                if (object.type === "variable") {
+                    if (object.template) {
+                        console.warn(
+                            'Warning, a variable object is using a Tiled "template". WorkAdventure does not support objects generated from Tiled templates.'
+                        );
+                        continue;
+                    }
+
+                    // We store a copy of the object (to make it immutable)
+                    objects.set(object.name, this.iTiledObjectToVariable(object));
+                }
+            }
+        } else if (layer.type === "group") {
+            for (const innerLayer of layer.layers) {
+                this.recursiveFindVariablesInLayer(innerLayer, objects);
+            }
+        }
+    }
+
     private static iTiledObjectToVariable(object: ITiledMapObject): Variable {
         const variable: Variable = {
             defaultValue: undefined,