Merge branch 'feat-viewer-deps' into 'master'

[FEAT][SDK] check for dependencies between viewer modules

See merge request codingame/game-engine!313

Author: Julien Poulton

engine/community-modules/camera/src/main/java/com/codingame/gameengine/module/camera/CameraModule.java

@@ -77,7 +77,7 @@ private void sendFrameData() {
             data[3] = active;
         }
         if (!Arrays.equals(data, empty)) {
-            gameManager.setViewData("c", data);
+            gameManager.setViewData("camera", data);
         }
     }
 

engine/community-modules/camera/src/main/resources/view/camera-module/CameraModule.js

@@ -23,8 +23,12 @@ export class CameraModule {
 
     }
 
-    static get name() {
-        return 'c'
+    static get moduleName() {
+        return 'camera'
+    }
+
+    static get dependencies () {
+        return ['entitymodule']
     }
 
     static setActive(active) {

engine/community-modules/camera/src/main/resources/view/camera-module/CameraToggleModule.js

@@ -38,10 +38,15 @@ export class CameraToggleModule {
         return option
     }
 
-    static get name() {
-        return 'toggles'
+    static get moduleName () {
+        return 'camera-toggle'
     }
 
+    static get dependencies () {
+        return ['camera']
+    }
+    
+
     updateScene(previousData, currentData, progress) {
         this.currentFrame = currentData
         this.currentProgress = progress

engine/core/src/main/resources/view/core/Drawer.js

@@ -92,11 +92,19 @@ export class Drawer {
 
   instantiateModules () {
     this.modules = {}
+    
     for (const Module of config.modules) {
       try {
-        this.modules[Module.moduleName || Module.name] = new Module(assets)
+        const dependencies = Module.dependencies ?? []
+        for (let dep of dependencies) {
+          if (this.modules[dep] == null) {
+            throw new Error(`Required module "${dep}" not yet loaded. Make sure it comes first in your config.js "modules" array`)
+          }
+        }
+
+        this.modules[Module.moduleName ?? Module.name] = new Module(assets)
       } catch (error) {
-        this.handleModuleError(Module.moduleName || Module.name, error)
+        this.handleModuleError(Module.moduleName ?? Module.name, error)
       }
     }
   }
@@ -215,7 +223,6 @@ export class Drawer {
           scope.logo = logo
         } catch (error) {
           ErrorLog.push({
-            cause: error,
             message: 'Missing "logo.png" to complete replay.'
           })
           scope.logo = new PIXI.Container()

engine/modules/endscreen/src/main/resources/view/endscreen-module/EndScreenModule.js

@@ -13,7 +13,7 @@ export class EndScreenModule {
     this.atEnd = false
   }
 
-  static get name () {
+  static get moduleName () {
     return 'endScreen'
   }
 

engine/modules/entities/src/main/resources/view/entity-module/GraphicEntityModule.js

@@ -25,7 +25,7 @@ export class GraphicEntityModule {
     api.entities = this.entities
   }
 
-  static get name () {
+  static get moduleName () {
     return 'entitymodule'
   }
 

engine/modules/toggle/src/main/resources/view/toggle-module/ToggleModule.js

@@ -44,10 +44,14 @@ export class ToggleModule {
     return option
   }
 
-  static get name () {
+  static get moduleName () {
     return 'toggles'
   }
 
+  static get dependencies () {
+    return ['entitymodule']
+  }
+
   updateScene (previousData, currentData, progress) {
     this.currentFrame = currentData
     this.currentProgress = progress

engine/modules/tooltip/src/main/resources/view/tooltip-module/TooltipModule.js

@@ -115,9 +115,13 @@ export class TooltipModule {
     this.lastFrame = 0
   }
 
-  static get name () {
+  static get moduleName () {
     return 'tooltips'
   }
+  static get dependencies () {
+    return ['entitymodule']
+  }
+
 
   updateScene (previousData, currentData, progress) {
     this.currentFrame = currentData

engine/modules/viewport/src/main/resources/view/viewport-module/ViewportModule.js

@@ -5,9 +5,12 @@ import vp from './lib/viewport.es.js'
 
 export class ViewportModule {
 
-  static get name() {
+  static get moduleName () {
     return 'viewport'
   }
+  static get dependencies () {
+    return ['entitymodule']
+  }
 
   entityIds = []
 

playground/misc/misc-3-release-notes.md

@@ -2,7 +2,13 @@
 
 The CodinGame SDK is regularly updated and improved. This document lets you know what changed in the latest releases.
 
-## ## 4.3.1
+## Next Release
+
+### 🐞 Bug fix
+
+- Enforce dependencies between certain viewer modules.
+
+## 4.3.1
 
 ### 🐞 Bug fix