fix(SDK): repair ToggleModule

Author: Bullle

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

@@ -1,21 +1,23 @@
-import { api as entityModule } from '../../entity-module/GraphicEntityModule.js'
-import { toggles } from '../../config.js'
+import { api as entityModule } from '../entity-module/GraphicEntityModule.js'
 import {ErrorLog} from '../core/ErrorLog.js'
 import {MissingToggleError} from './errors/MissingToggleError.js'
+import {DuplicateToggleValueError} from './errors/DuplicateToggleValueError.js'
 
 export class ToggleModule {
+	   
   constructor (assets) {
     this.previousFrame = {}
     this.missingToggles = {}
+    
     ToggleModule.refreshContent = () => {
-      if (!this.currentFrame) {
+      if (!this.currentFrame || !ToggleModule.toggles) {
         return
       }
       for (const registeredEntity in this.currentFrame.registered) {
         const entity = entityModule.entities.get(parseInt(registeredEntity))
         const toggleInfo = this.currentFrame.registered[registeredEntity]
-        const toggleState = toggles[toggleInfo.name]
-
+        const toggleState = ToggleModule.toggles[toggleInfo.name]
+        
         if (toggleState == null && !this.missingToggles[toggleInfo.name]) {
           ErrorLog.push(new MissingToggleError(toggleInfo.name))
           this.missingToggles[toggleInfo.name] = true
@@ -25,9 +27,29 @@ export class ToggleModule {
         )
       }
     }
+    
+    for (const e of ToggleModule.errors) {
+    	ErrorLog.push(e)
+    }
+    
   }
+
   static refreshContent () {}
 
+  static defineToggle(option) {
+	  if (new Set(Object.values(option.values)).size != Object.values(option.values).length) {
+		  ToggleModule.errors.push(new DuplicateToggleValueError(option.toggle))
+	  }
+
+	  ToggleModule.toggles[option.toggle] = option.default
+	  option.get = () => ToggleModule.toggles[option.toggle]
+	  option.set = (value) => {
+		  ToggleModule.toggles[option.toggle] = value
+		  ToggleModule.refreshContent()
+	  }
+	  return option
+  }
+
   static get name () {
     return 'toggles'
   }
@@ -53,3 +75,6 @@ export class ToggleModule {
     ToggleModule.refreshContent()
   }
 }
+
+ToggleModule.toggles = {}
+ToggleModule.errors = []

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

@@ -0,0 +1,8 @@
+export class DuplicateToggleValueError extends Error {
+  constructor (toggle, cause) {
+    super('Duplicate values in toggle "' + toggle + '". Make sure it is set up correctly in your config.js.')
+    this.toggle = toggle
+    this.cause = cause
+    this.name = 'DuplicateToggleValueError'
+  }
+}

playground/extensions/extensions-toggle.md

@@ -29,36 +29,22 @@ export const modules = [
 
 // The list of toggles displayed in the options of the viewer
 export const options = [
-  {
-  // The name displayed over the toggle
+  ToggleModule.defineToggle({
+    // The name of the toggle
+    toggle: 'myToggle',
+    // The text displayed over the toggle
     title: 'MY TOGGLE',
-    // Getters and setters for the on/off state of your toggle
-    get: function () {
-      return toggles.myToggle // replace "myToggle" by the name of the toggle you want to use
-    },
-    set: function (value) {
-      toggles.myToggle = value // replace "myToggle" by the name of the toggle you want to use
-      ToggleModule.refreshContent()
-    },
     // The labels for the on/off states of your toggle
     values: {
       'TOGGLED ON': true,
       'TOGGLED OFF': false
     }
-  },
-  {
-    title: 'MY OTHER TOGGLE',
+  }),
+  ToggleModule.defineToggle({
+    toggle: 'myOtherToggle',
     ⋮
-  }
+  })
 ]
-
-// The list of the toggles used by the ToggleModule
-// replace "myToggle" by the name of the toggle you want to use
-export const toggles = {
-  myToggle: true, // default value of your toggle
-  myOtherToggle: false
-}
-
 ```
 
 ## Usage

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

@@ -2,6 +2,12 @@
 
 The CodinGame SDK is regularly updated and improved. This document lets you know what changed in the latest releases.
 
+## Next Version
+
+### 🐞 Bug fix
+
+- Fixed ToggleModule and added a better API.
+
 ## 3.4.6
 
 ### 🐞 Bug fix