Get saving buildings in game functional

Author: FifthTundraG

src/ts/buildings.ts

@@ -1,6 +1,7 @@
 import ClickerCookie from "./clickercookie.js";
 import { capitalize, commaify, clamp } from "./helper.js";
 import { Game } from "./main.js";
+import { SaveProvider } from "./saving.js";
 import { hideTooltip } from "./tooltip.js";
 
 export interface BuildingData {
@@ -17,7 +18,13 @@ export interface BuildingData {
     upgradeCostMultiplier?: number;
 }
 
-export class Building {
+export interface BuildingSave {
+    bought: number;
+    CPSGain: number;
+    CPSGiven: number;
+}
+
+export class Building extends SaveProvider {
     private _clickercookie: ClickerCookie;
 
     name: string;
@@ -49,6 +56,8 @@ export class Building {
 
     html: HTMLDivElement;
     constructor(clickercookie: ClickerCookie, data: BuildingData) {
+        super();
+
         this._clickercookie = clickercookie;
 
         // setup HTML (uses indentation to show structure)
@@ -164,4 +173,18 @@ export class Building {
     destroy() {
         this.html.remove();
     }
+
+    getSaveData(): BuildingSave {
+        return {
+            bought: this.bought,
+            CPSGain: this.CPSGain,
+            CPSGiven: this.CPSGiven
+        }
+    }
+
+    loadSaveData(saveData: BuildingSave) {
+        this.bought = saveData.bought;
+        this.CPSGain = saveData.CPSGain;
+        this.CPSGiven = saveData.CPSGiven
+    }
 }

src/ts/clickercookie.ts

@@ -30,36 +30,6 @@ interface ClickerCookieSaveData {
     totalCookies: number;
     cookiesPerClick: number;
     cookieBeenClickedTimes: number;
-
-    /* buildings */
-    // keyboard
-    keyboardsBought: number;
-    keyboardCPSGain: number;
-    keyboardCPSGiven: number;
-    // grandpa
-    grandpasBought: number;
-    grandpaCPSGain: number;
-    grandpaCPSGiven: number;
-    // ranch
-    ranchesBought: number;
-    ranchCPSGain: number;
-    ranchCPSGiven: number;
-    // television
-    televisionsBought: number;
-    televisionCPSGain: number;
-    televisionCPSGiven: number; 
-    // worker
-    workersBought: number;
-    workerCPSGain: number;
-    workerCPSGiven: number;
-    // wallet
-    walletsBought: number;
-    walletCPSGain: number;
-    walletCPSGiven: number; 
-    // church
-    churchesBought: number;
-    churchCPSGain: number;
-    churchCPSGiven: number;
 }
 
 export default class ClickerCookie extends Mod {
@@ -643,45 +613,10 @@ export default class ClickerCookie extends Mod {
             cookies: this.cookies,
             totalCookies: this.totalCookies,
             cookiesPerClick: this.cookiesPerClick,
-            cookieBeenClickedTimes: this.cookieBeenClickedTimes,
-            /* buildings */
-            // keyboard
-            keyboardsBought: this.keyboard.bought,
-            keyboardCPSGain: this.keyboard.CPSGain,
-            keyboardCPSGiven: this.keyboard.CPSGiven,
-            // grandpa
-            grandpasBought: this.grandpa.bought,
-            grandpaCPSGain: this.grandpa.CPSGain,
-            grandpaCPSGiven: this.grandpa.CPSGiven,
-            // ranch
-            ranchesBought: this.ranch.bought,
-            ranchCPSGain: this.ranch.CPSGain,
-            ranchCPSGiven: this.ranch.CPSGiven,
-            // television
-            televisionsBought: this.television.bought,
-            televisionCPSGain: this.television.CPSGain,
-            televisionCPSGiven: this.television.CPSGiven,
-            // worker
-            workersBought: this.worker.bought,
-            workerCPSGain: this.worker.CPSGain,
-            workerCPSGiven: this.worker.CPSGiven,
-            // wallet
-            walletsBought: this.wallet.bought,
-            walletCPSGain: this.wallet.CPSGain,
-            walletCPSGiven: this.wallet.CPSGiven,
-            // church
-            churchesBought: this.church.bought,
-            churchCPSGain: this.church.CPSGain,
-            churchCPSGiven: this.church.CPSGiven
+            cookieBeenClickedTimes: this.cookieBeenClickedTimes
         }
     }
-    loadSaveData(saveData: ClickerCookieSaveData) {        
-        for (const i in saveData) {
-            if (i === undefined) {
-                console.warn("During loading a value in saveData was found undefined. Errors will likely follow...");
-            }
-        }
-        
+    loadSaveData(saveData: ClickerCookieSaveData) {
         this.grandpa.setVisibility(false);
         this.ranch.setVisibility(false);
         this.television.setVisibility(false);
@@ -693,36 +628,5 @@ export default class ClickerCookie extends Mod {
         this.totalCookies = saveData.totalCookies;
         this.cookiesPerClick = saveData.cookiesPerClick;
         this.cookieBeenClickedTimes = saveData.cookieBeenClickedTimes;
-
-        /* buildings */
-        // keyboard
-        this.keyboard.bought = saveData.keyboardsBought;
-        this.keyboard.CPSGain = saveData.keyboardCPSGain;
-        this.keyboard.CPSGiven = saveData.keyboardCPSGiven;
-        // grandpa
-        this.grandpa.bought = saveData.grandpasBought;
-        this.grandpa.CPSGain = saveData.grandpaCPSGain;
-        this.grandpa.CPSGiven = saveData.grandpaCPSGiven;
-        // ranch
-        this.ranch.bought = saveData.ranchesBought;
-        this.ranch.CPSGain = saveData.ranchCPSGain;
-        this.ranch.CPSGiven = saveData.ranchCPSGiven;
-        // television
-        this.television.bought = saveData.televisionsBought;
-        this.television.CPSGain = saveData.televisionCPSGain;
-        this.television.CPSGiven = saveData.televisionCPSGiven;
-        // worker
-        this.worker.bought = saveData.workersBought;
-        this.worker.CPSGain = saveData.workerCPSGain;
-        this.worker.CPSGiven = saveData.workerCPSGiven;
-        // wallet
-        this.wallet.bought = saveData.walletsBought;
-        this.wallet.CPSGain = saveData.walletCPSGain;
-        this.wallet.CPSGiven = saveData.walletCPSGiven;
-        // church
-        this.church.bought = saveData.churchesBought;
-        this.church.CPSGain = saveData.churchCPSGain;
-        this.church.CPSGiven = saveData.churchCPSGiven;
-        // ...
     }
 }

src/ts/handlers.ts

@@ -1,6 +1,6 @@
 //* Ideally I would put things like BackgroundHandler in personalization.ts but because of lexical declarations we can't do that without getting circular imports as far as I can tell. This is fine.
 
-import { Building } from "./buildings.js";
+import { Building, BuildingSave } from "./buildings.js";
 import { Handler, Identifier, UniqueKeyHandler } from "./handler.js";
 import { url } from "./helper.js";
 import { Game, GameSaveData } from "./main.js";
@@ -126,6 +126,38 @@ export class BuildingHandler extends Handler<Building> {
         }
         return bought;
     }
+
+    /**
+     * Dumps savedata for all registered buildings
+     * @param namespace Optional: if present only dump savedata from this namespace
+     * @returns savedata as obj in following format: `stringifiedIdentifier: BuildingSave`
+     */
+    dumpSave(namespace: string=undefined) {
+        const saveObj: Record<string, BuildingSave> = {};
+        for (const value of (namespace === undefined) ? this : this.getValuesFromNamespace(namespace)) {
+            saveObj[this.getKeyFromValue(value)] = value.getSaveData();
+        }
+        return saveObj;
+    }
+
+    /**
+     * Apply save data state to all registered buildings
+     * @param saveObj The save object to load the data of
+     * @param namespace Optional: if present will only load data for buildings of a given namespace.
+     */
+    loadSave(saveObj: Record<string, BuildingSave>, namespace: string=undefined) {
+        for (const stringifiedIdentifier in saveObj) {
+            const id = Identifier.fromString(stringifiedIdentifier);
+
+            if (namespace !== undefined && id.namespace !== namespace) continue;
+
+            const building = this.getFromIdentifier(id);
+
+            if (building === undefined) continue; // if buildings are not registered we obviously can't load them. todo: should this warn?
+
+            building.loadSaveData(saveObj[stringifiedIdentifier]);
+        }
+    }
 }
 
 /* Upgrades */
@@ -238,9 +270,6 @@ export class ModHandler extends UniqueKeyHandler<Mod> {
 
         Game.getInstance().isModded = true;
 
-        // load game save data to todo: write
-        Game.getInstance().loadSaveData(Game.getInstance().savinator5000.getLocalStorageSave().getData("game") as GameSaveData);
-
         console.log("Loaded mod from URL: "+url);
     }
 
@@ -265,9 +294,6 @@ export class ModHandler extends UniqueKeyHandler<Mod> {
 
             Game.getInstance().isModded = true;
 
-            // load game save data to todo: write
-            Game.getInstance().loadSaveData(Game.getInstance().savinator5000.getLocalStorageSave().getData("game") as GameSaveData)
-
             console.log("Successfully added mod from file: "+file.name);
         };
     }
@@ -347,11 +373,15 @@ export class ModHandler extends UniqueKeyHandler<Mod> {
             new SimplePopup({x: 400, y: 200, title: "Error", text: `The mod namespace "${key}" is already present!`});
             return;
         }
+
+        if (Game.getInstance().initialized) Game.getInstance().savinator5000.save(); // save and load to save any changes made since last save and load so that buildings and upgrades will be loaded for the mod we just added
 
         super.register(key, mod);
         this.saveHandler.register(mod.NAMESPACE, mod);
         document.getElementById("modsNumberLoaded")!.innerText = (Handlers.MOD.length - 1).toString(); //* subtract one so we don't show clickercookie (makes more sense to the user)
-        mod.init();
+        mod.init(); // register their stuff
+
+        if (Game.getInstance().initialized) Game.getInstance().savinator5000.load();
     }
 }
 

src/ts/main.ts

@@ -16,6 +16,7 @@ import { SimplePopup } from "./popup.js";
 import { Handlers, ModHandler } from "./handlers.js";
 
 import { NewMod } from "./exmod.js"; //* note: this import is intentionally left unused so tsc can find this file and compile it
+import { BuildingSave } from "./buildings.js";
 
 // ------------------------------------
 // Version Constants
@@ -76,7 +77,8 @@ export interface GameSaveData {
     currentlyClickedObjectKey: string;
     currentBackgroundKey: string;
 
-    upgradesSave: Record<string, UpgradeSave>
+    upgradesSave: Record<string, UpgradeSave>;
+    buildingsSave: Record<string, BuildingSave>;
 }
 
 export class Game extends SaveProvider {
@@ -152,7 +154,7 @@ export class Game extends SaveProvider {
         y: number
     };
 
-    public theGameCanLoopBecauseTheInitializationIsCompleted: boolean;
+    public initialized: boolean;
 
     //* The following intervals will be started once init() completes!
     public readonly AUTOSAVE_INTERVAL = new Interval(() => {
@@ -183,7 +185,7 @@ export class Game extends SaveProvider {
 
         this.savinator5000 = new Savinator(Handlers.SAVE);
 
-        this.theGameCanLoopBecauseTheInitializationIsCompleted = false;
+        this.initialized = false;
     }
 
     init() {
@@ -296,12 +298,12 @@ export class Game extends SaveProvider {
         this.CPS_INTERVAL.start();
         this.GAME_LOOP_INTERVAL.start();
 
-        this.theGameCanLoopBecauseTheInitializationIsCompleted = true;
+        this.initialized= true;
         console.log("Successfully completed initialization.");
     }
 
     gameLoop() {
-        if (!this.theGameCanLoopBecauseTheInitializationIsCompleted) return;
+        if (!this.initialized) return;
 
         Handlers.UPGRADE.checkUpgradeAvailability();
 
@@ -347,7 +349,8 @@ export class Game extends SaveProvider {
 
     getSaveData(): GameSaveData {
         /** savedata is null on first boot */
-        const originalUpgradeSave = (this.savinator5000.getLocalStorageSave()) ? (this.savinator5000.getLocalStorageSave().getData("game") as GameSaveData).upgradesSave : {}
+        const originalUpgradeSave = (this.savinator5000.getLocalStorageSave()) ? (this.savinator5000.getLocalStorageSave().getData("game") as GameSaveData).upgradesSave : {};
+        const originalBuildingSave = (this.savinator5000.getLocalStorageSave()) ? (this.savinator5000.getLocalStorageSave().getData("game") as GameSaveData).buildingsSave : {};
 
         return {
             hasCheated: this.hasCheated,
@@ -361,6 +364,10 @@ export class Game extends SaveProvider {
             upgradesSave: { // merge to preserve unregistered upgrades
                 ...originalUpgradeSave,
                 ...Handlers.UPGRADE.dumpSave()
+            },
+            buildingsSave: {
+                ...originalBuildingSave,
+                ...Handlers.BUILDING.dumpSave()
             }
         }
     }
@@ -375,6 +382,7 @@ export class Game extends SaveProvider {
 
         // the following doesn't have anything to do with GameSaveData but will be done here because this spot makes the most sense
         Handlers.UPGRADE.loadSave(saveData.upgradesSave);
+        Handlers.BUILDING.loadSave(saveData.buildingsSave);
 
         Handlers.UPGRADE.destroyAllUpgrades();
         Handlers.UPGRADE.showUnlockedUpgrades();

src/ts/saving.ts

@@ -151,6 +151,7 @@ export class Savinator {
     }
 }
 
+// todo: change the documentation of this class to reflect additional uses, such as Building
 export class SaveProvider {
     /**
      * If registered with a {@link SaveHandler}, it will use whatever this function returns as the savedata.