Complete overhaul of code structure and relevant files (#639)

src/Main/CheckStates/Garden.js

@@ -0,0 +1,17 @@
+import { CMOptions } from '../../Config/VariablesAndData';
+import Flash from '../../Disp/Notifications/Flash';
+import PlaySound from '../../Disp/Notifications/Sound';
+import { LastGardenNextStep } from '../VariablesAndData';
+
+/**
+ * This function checks if a garden tick has happened
+ */
+export default function CheckGardenTick() {
+	if (Game.Objects.Farm.minigameLoaded && LastGardenNextStep !== Game.Objects.Farm.minigame.nextStep) {
+		if (LastGardenNextStep !== 0 && LastGardenNextStep < Date.now()) {
+			Flash(3, 'GardFlash');
+			PlaySound(CMOptions.GardSoundURL, 'GardSound', 'GardVolume');
+		}
+		LastGardenNextStep = Game.Objects.Farm.minigame.nextStep;
+	}
+}

src/Main/CheckStates/GoldenCookie.js

@@ -0,0 +1,66 @@
+/* eslint-disable no-unused-vars */
+import { CacheSpawnedGoldenShimmer, CacheGoldenShimmersByID } from '../../Cache/VariablesAndData';
+import { CMOptions } from '../../Config/VariablesAndData';
+import CreateGCTimer from '../../Disp/GoldenCookieTimers/GoldenCookieTimers';
+import Flash from '../../Disp/Notifications/Flash';
+import Notification from '../../Disp/Notifications/Notification';
+import PlaySound from '../../Disp/Notifications/Sound';
+import { UpdateFavicon } from '../../Disp/TabTitle/FavIcon';
+import { GCTimers } from '../../Disp/VariablesAndData';
+import { CurrSpawnedGoldenCookieState, LastGoldenCookieState, LastSpawnedGoldenCookieState } from '../VariablesAndData';
+
+/**
+ * Auxilirary function that finds all currently spawned shimmers.
+ * CM.Cache.spawnedGoldenShimmer stores the non-user spawned cookie to later determine data for the favicon and tab-title
+ * It is called by CM.CM.Main.CheckGoldenCookie
+ */
+function FindShimmer() {
+	CurrSpawnedGoldenCookieState = 0;
+	CacheGoldenShimmersByID = {};
+	for (const i of Object.keys(Game.shimmers)) {
+		CacheGoldenShimmersByID[Game.shimmers[i].id] = Game.shimmers[i];
+		if (Game.shimmers[i].spawnLead && Game.shimmers[i].type === 'golden') {
+			CacheSpawnedGoldenShimmer = Game.shimmers[i];
+			CurrSpawnedGoldenCookieState += 1;
+		}
+	}
+}
+
+/**
+ * This function checks for changes in the amount of Golden Cookies
+ * It is called by CM.Main.Loop
+ */
+export default function CheckGoldenCookie() {
+	FindShimmer();
+	for (const i of Object.keys(GCTimers)) {
+		if (typeof CacheGoldenShimmersByID[i] === 'undefined') {
+			GCTimers[i].parentNode.removeChild(GCTimers[i]);
+			delete GCTimers[i];
+		}
+	}
+	if (LastGoldenCookieState !== Game.shimmerTypes.golden.n) {
+		LastGoldenCookieState = Game.shimmerTypes.golden.n;
+		if (LastGoldenCookieState) {
+			if (LastSpawnedGoldenCookieState < CurrSpawnedGoldenCookieState) {
+				Flash(3, 'GCFlash');
+				PlaySound(CMOptions.GCSoundURL, 'GCSound', 'GCVolume');
+				Notification('GCNotification', 'Golden Cookie Spawned', 'A Golden Cookie has spawned. Click it now!');
+			}
+
+			for (const i of Object.keys(Game.shimmers)) {
+				if (typeof GCTimers[Game.shimmers[i].id] === 'undefined') {
+					CreateGCTimer(Game.shimmers[i]);
+				}
+			}
+		}
+		UpdateFavicon();
+		LastSpawnedGoldenCookieState = CurrSpawnedGoldenCookieState;
+		if (CurrSpawnedGoldenCookieState === 0) CacheSpawnedGoldenShimmer = 0;
+	} else if (CMOptions.GCTimer === 1 && LastGoldenCookieState) {
+		for (const i of Object.keys(GCTimers)) {
+			GCTimers[i].style.opacity = CacheGoldenShimmersByID[i].l.style.opacity;
+			GCTimers[i].style.transform = CacheGoldenShimmersByID[i].l.style.transform;
+			GCTimers[i].textContent = Math.ceil(CacheGoldenShimmersByID[i].life / Game.fps);
+		}
+	}
+}

src/Main/CheckStates/Grimoire.js

@@ -0,0 +1,22 @@
+import { CMOptions } from '../../Config/VariablesAndData';
+import Flash from '../../Disp/Notifications/Flash';
+import Notification from '../../Disp/Notifications/Notification';
+import PlaySound from '../../Disp/Notifications/Sound';
+import { LastMagicBarFull } from '../VariablesAndData';
+
+/**
+ * This function checks if the magic meter is full
+ * It is called by CM.Main.Loop
+ */
+export default function CheckMagicMeter() {
+	if (Game.Objects['Wizard tower'].minigameLoaded && CMOptions.GrimoireBar === 1) {
+		const minigame = Game.Objects['Wizard tower'].minigame;
+		if (minigame.magic < minigame.magicM) LastMagicBarFull = false;
+		else if (!LastMagicBarFull) {
+			LastMagicBarFull = true;
+			Flash(3, 'MagicFlash');
+			PlaySound(CMOptions.MagicSoundURL, 'MagicSound', 'MagicVolume');
+			Notification('MagicNotification', 'Magic Meter full', 'Your Magic Meter is full. Cast a spell!');
+		}
+	}
+}

src/Main/CheckStates/Season.js

@@ -0,0 +1,26 @@
+/* eslint-disable no-unused-vars */
+import { CacheSeasonPopShimmer } from '../../Cache/VariablesAndData';
+import { CMOptions } from '../../Config/VariablesAndData';
+import Flash from '../../Disp/Notifications/Flash';
+import Notification from '../../Disp/Notifications/Notification';
+import PlaySound from '../../Disp/Notifications/Sound';
+import { LastSeasonPopupState } from '../VariablesAndData';
+
+/**
+ * This function checks if there is reindeer that has spawned
+ * It is called by CM.Main.Loop
+ */
+export default function CheckSeasonPopup() {
+	if (LastSeasonPopupState !== Game.shimmerTypes.reindeer.spawned) {
+		LastSeasonPopupState = Game.shimmerTypes.reindeer.spawned;
+		for (const i of Object.keys(Game.shimmers)) {
+			if (Game.shimmers[i].spawnLead && Game.shimmers[i].type === 'reindeer') {
+				CacheSeasonPopShimmer = Game.shimmers[i];
+				break;
+			}
+		}
+		Flash(3, 'SeaFlash');
+		PlaySound(CMOptions.SeaSoundURL, 'SeaSound', 'SeaVolume');
+		Notification('SeaNotification', 'Reindeer sighted!', 'A Reindeer has spawned. Click it now!');
+	}
+}

src/Main/CheckStates/Ticker.js

@@ -0,0 +1,19 @@
+import Flash from '../../Disp/Notifications/Flash';
+import Notification from '../../Disp/Notifications/Notification';
+import PlaySound from '../../Disp/Notifications/Sound';
+import { LastTickerFortuneState } from '../VariablesAndData';
+
+/**
+ * This function checks if there is a fortune cookie on the ticker
+ * It is called by CM.Main.Loop
+ */
+export default function CheckTickerFortune() {
+	if (LastTickerFortuneState !== (Game.TickerEffect && Game.TickerEffect.type === 'fortune')) {
+		LastTickerFortuneState = (Game.TickerEffect && Game.TickerEffect.type === 'fortune');
+		if (LastTickerFortuneState) {
+			Flash(3, 'FortuneFlash');
+			PlaySound(CM.Options.FortuneSoundURL, 'FortuneSound', 'FortuneVolume');
+			Notification('FortuneNotification', 'Fortune Cookie found', 'A Fortune Cookie has appeared on the Ticker.');
+		}
+	}
+}

src/Main/CheckStates/Wrinkler.js

@@ -0,0 +1,38 @@
+import { CMOptions } from '../../Config/VariablesAndData';
+import Flash from '../../Disp/Notifications/Flash';
+import Notification from '../../Disp/Notifications/Notification';
+import PlaySound from '../../Disp/Notifications/Sound';
+import { LastWrinklerCount } from '../VariablesAndData';
+
+/**
+ * This function checks if any new Wrinklers have popped up
+ * It is called by CM.Main.Loop
+ */
+export default function CheckWrinklerCount() {
+	if (Game.elderWrath > 0) {
+		let CurrentWrinklers = 0;
+		for (const i in Game.wrinklers) {
+			if (Game.wrinklers[i].phase === 2) CurrentWrinklers++;
+		}
+		if (CurrentWrinklers > LastWrinklerCount) {
+			LastWrinklerCount = CurrentWrinklers;
+			if (CurrentWrinklers === Game.getWrinklersMax() && CMOptions.WrinklerMaxFlash) {
+				Flash(3, 'WrinklerMaxFlash');
+			} else {
+				Flash(3, 'WrinklerFlash');
+			}
+			if (CurrentWrinklers === Game.getWrinklersMax() && CMOptions.WrinklerMaxSound) {
+				PlaySound(CMOptions.WrinklerMaxSoundURL, 'WrinklerMaxSound', 'WrinklerMaxVolume');
+			} else {
+				PlaySound(CMOptions.WrinklerSoundURL, 'WrinklerSound', 'WrinklerVolume');
+			}
+			if (CurrentWrinklers === Game.getWrinklersMax() && CMOptions.WrinklerMaxNotification) {
+				Notification('WrinklerMaxNotification', 'Maximum Wrinklers Reached', 'You have reached your maximum ammount of wrinklers');
+			} else {
+				Notification('WrinklerNotification', 'A Wrinkler appeared', 'A new wrinkler has appeared');
+			}
+		} else {
+			LastWrinklerCount = CurrentWrinklers;
+		}
+	}
+}