Added layersupport to waypoints!! (#703)

* Added layersupport to waypoints!!
It will now save what layer its made on!

* Added Migrator for 1006 to 1007

* Corrected Version Number

* Updated Comment

* Changed HUB Layer to be hardcoded

src/js/game/hud/parts/waypoints.js

@@ -1,6 +1,7 @@
 import { makeOffscreenBuffer } from "../../../core/buffer_utils";
 import { globalConfig, THIRDPARTY_URLS } from "../../../core/config";
 import { DrawParameters } from "../../../core/draw_parameters";
+import { gMetaBuildingRegistry } from "../../../core/global_registries";
 import { Loader } from "../../../core/loader";
 import { DialogWithForm } from "../../../core/modal_dialog_elements";
 import { FormElementInput } from "../../../core/modal_dialog_forms";
@@ -16,8 +17,10 @@ import {
 import { Vector } from "../../../core/vector";
 import { T } from "../../../translations";
 import { BaseItem } from "../../base_item";
+import { MetaHubBuilding } from "../../buildings/hub";
 import { enumMouseButton } from "../../camera";
 import { KEYMAPPINGS } from "../../key_action_mapper";
+import { layers } from "../../root";
 import { ShapeDefinition } from "../../shape_definition";
 import { BaseHUDPart } from "../base_hud_part";
 import { DynamicDomAttach } from "../dynamic_dom_attach";
@@ -26,7 +29,8 @@ import { enumNotificationType } from "./notifications";
 /** @typedef {{
  *   label: string | null,
  *   center: { x: number, y: number },
- *   zoomLevel: number
+ *   zoomLevel: number,
+ *   layer: Layer,
  * }} Waypoint */
 
 /**
@@ -98,6 +102,7 @@ export class HUDWaypoints extends BaseHUDPart {
                 label: null,
                 center: { x: 0, y: 0 },
                 zoomLevel: 3,
+                layer: gMetaBuildingRegistry.findByClass(MetaHubBuilding).getLayer(),
             },
         ];
 
@@ -228,6 +233,7 @@ export class HUDWaypoints extends BaseHUDPart {
      * @param {Waypoint} waypoint
      */
     moveToWaypoint(waypoint) {
+        this.root.currentLayer = waypoint.layer;
         this.root.camera.setDesiredCenter(new Vector(waypoint.center.x, waypoint.center.y));
         this.root.camera.setDesiredZoom(waypoint.zoomLevel);
     }
@@ -326,6 +332,7 @@ export class HUDWaypoints extends BaseHUDPart {
             label,
             center: { x: position.x, y: position.y },
             zoomLevel: this.root.camera.zoomLevel,
+            layer: this.root.currentLayer,
         });
 
         this.sortWaypoints();

src/js/savegame/savegame.js

@@ -11,6 +11,7 @@ import { SavegameInterface_V1003 } from "./schemas/1003";
 import { SavegameInterface_V1004 } from "./schemas/1004";
 import { SavegameInterface_V1005 } from "./schemas/1005";
 import { SavegameInterface_V1006 } from "./schemas/1006";
+import { SavegameInterface_V1007 } from "./schemas/1007";
 
 const logger = createLogger("savegame");
 
@@ -51,7 +52,7 @@ export class Savegame extends ReadWriteProxy {
      * @returns {number}
      */
     static getCurrentVersion() {
-        return 1006;
+        return 1007;
     }
 
     /**
@@ -120,6 +121,11 @@ export class Savegame extends ReadWriteProxy {
             data.version = 1006;
         }
 
+        if (data.version === 1006) {
+            SavegameInterface_V1007.migrate1006to1007(data);
+            data.version = 1007;
+        }
+
         return ExplainedResult.good();
     }
 

src/js/savegame/savegame_interface_registry.js

@@ -7,6 +7,7 @@ import { SavegameInterface_V1003 } from "./schemas/1003";
 import { SavegameInterface_V1004 } from "./schemas/1004";
 import { SavegameInterface_V1005 } from "./schemas/1005";
 import { SavegameInterface_V1006 } from "./schemas/1006";
+import { SavegameInterface_V1007 } from "./schemas/1007";
 
 /** @type {Object.<number, typeof BaseSavegameInterface>} */
 export const savegameInterfaces = {
@@ -17,6 +18,7 @@ export const savegameInterfaces = {
     1004: SavegameInterface_V1004,
     1005: SavegameInterface_V1005,
     1006: SavegameInterface_V1006,
+    1007: SavegameInterface_V1007,
 };
 
 const logger = createLogger("savegame_interface_registry");

src/js/savegame/schemas/1007.js

@@ -0,0 +1,34 @@
+import { createLogger } from "../../core/logging.js";
+import { SavegameInterface_V1006 } from "./1006.js";
+
+const schema = require("./1007.json");
+const logger = createLogger("savegame_interface/1007");
+
+export class SavegameInterface_V1007 extends SavegameInterface_V1006 {
+    getVersion() {
+        return 1007;
+    }
+
+    getSchemaUncached() {
+        return schema;
+    }
+
+    /**
+     * @param {import("../savegame_typedefs.js").SavegameData} data
+     */
+    static migrate1006to1007(data) {
+        logger.log("Migrating 1006 to 1007");
+        const dump = data.dump;
+        if (!dump) {
+            return true;
+        }
+
+        const waypoints = dump.waypoints.waypoints;
+
+        // set waypoint layer to "regular"
+        for (let i = 0; i < waypoints.length; ++i) {
+            const waypoint = waypoints[i];
+            waypoint.layer = "regular";
+        }
+    }
+}

src/js/savegame/schemas/1007.json

@@ -0,0 +1,5 @@
+{
+    "type": "object",
+    "required": [],
+    "additionalProperties": true
+}