Indicator when a candy upgrade is available (#1083)

* initial implementation * updated logic * reverse retTint * added candy overlays and colors * added settings and minor fixes * german changes * logic fix * german changes pt2 * german changes pt3 * setting name changed * Update battle-scene.ts * initial animation implementation * minor fixes * main compatibility * minor fix * logic for animations * eslint fixes * final generation logic * Pause Animation when Selected or Purchased * Disable Indicator if not Root Species * Add to Reload and Add Anchor * Fix Animation on Change * Fix Icon on Change * Code Cleanup * fix --------- Co-authored-by: Benjamin Odom <[email protected]>
pagefaultgames · May 28, 2024 · 7e003d6 · 7e003d6
1 parent 9893c21
commit 7e003d6
Show file tree

Hide file tree

Showing 5 changed files with 341 additions and 31 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/battle-scene-events.ts b/src/battle-scene-events.ts
@@ -2,6 +2,12 @@ import Move from "./data/move";
 
 /** Alias for all {@linkcode BattleScene} events */
 export enum BattleSceneEventType {
+  /**
+   * Triggers when the corresponding setting is changed
+   * @see {@linkcode CandyUpgradeNotificationChangedEvent}
+   */
+  CANDY_UPGRADE_NOTIFICATION_CHANGED = "onCandyUpgradeDisplayChanged",
+
   /**
    * Triggers when a move is successfully used
    * @see {@linkcode MoveUsedEvent}
@@ -24,6 +30,20 @@ export enum BattleSceneEventType {
   NEW_ARENA = "onNewArena",
 }
 
+/**
+ * Container class for {@linkcode BattleSceneEventType.CANDY_UPGRADE_NOTIFICATION_CHANGED} events
+ * @extends Event
+*/
+export class CandyUpgradeNotificationChangedEvent extends Event {
+  /** The new value the setting was changed to */
+  public newValue: number;
+  constructor(newValue: number) {
+    super(BattleSceneEventType.CANDY_UPGRADE_NOTIFICATION_CHANGED);
+
+    this.newValue = newValue;
+  }
+}
+
 /**
  * Container class for {@linkcode BattleSceneEventType.MOVE_USED} events
  * @extends Event

diff --git a/src/battle-scene.ts b/src/battle-scene.ts
@@ -93,6 +93,19 @@ export default class BattleScene extends SceneBase {
   public showLevelUpStats: boolean = true;
   public enableTutorials: boolean = import.meta.env.VITE_BYPASS_TUTORIAL === "1";
   public enableRetries: boolean = false;
+  /**
+   * Determines the condition for a notification should be shown for Candy Upgrades
+   * - 0 = 'Off'
+   * - 1 = 'Passives Only'
+   * - 2 = 'On'
+   */
+  public candyUpgradeNotification: integer = 0;
+  /**
+   * Determines what type of notification is used for Candy Upgrades
+   * - 0 = 'Icon'
+   * - 1 = 'Animation'
+   */
+  public candyUpgradeDisplay: integer = 0;
   public moneyFormat: MoneyFormat = MoneyFormat.NORMAL;
   public uiTheme: UiTheme = UiTheme.DEFAULT;
   public windowType: integer = 0;

diff --git a/src/system/settings.ts b/src/system/settings.ts
@@ -5,6 +5,7 @@ import BattleScene from "../battle-scene";
 import { hasTouchscreen } from "../touch-controls";
 import { updateWindowType } from "../ui/ui-theme";
 import { PlayerGender } from "./game-data";
+import { CandyUpgradeNotificationChangedEvent } from "#app/battle-scene-events.js";
 import { MoneyFormat } from "../enums/money-format";
 
 export enum Setting {
@@ -18,6 +19,8 @@ export enum Setting {
   Window_Type = "WINDOW_TYPE",
   Tutorials = "TUTORIALS",
   Enable_Retries = "ENABLE_RETRIES",
+  Candy_Upgrade_Notification = "CANDY_UPGRADE_NOTIFICATION",
+  Candy_Upgrade_Display = "CANDY_UPGRADE_DISPLAY",
   Money_Format = "MONEY_FORMAT",
   Sprite_Set = "SPRITE_SET",
   Move_Animations = "MOVE_ANIMATIONS",
@@ -52,6 +55,8 @@ export const settingOptions: SettingOptions = {
   [Setting.Window_Type]: new Array(5).fill(null).map((_, i) => (i + 1).toString()),
   [Setting.Tutorials]: ["Off", "On"],
   [Setting.Enable_Retries]: ["Off", "On"],
+  [Setting.Candy_Upgrade_Notification]: ["Off", "Passives Only", "On"],
+  [Setting.Candy_Upgrade_Display]: ["Icon", "Animation"],
   [Setting.Money_Format]: ["Normal", "Abbreviated"],
   [Setting.Sprite_Set]: ["Consistent", "Mixed Animated"],
   [Setting.Move_Animations]: ["Off", "On"],
@@ -78,6 +83,8 @@ export const settingDefaults: SettingDefaults = {
   [Setting.Window_Type]: 0,
   [Setting.Tutorials]: 1,
   [Setting.Enable_Retries]: 0,
+  [Setting.Candy_Upgrade_Notification]: 0,
+  [Setting.Candy_Upgrade_Display]: 0,
   [Setting.Money_Format]: 0,
   [Setting.Sprite_Set]: 0,
   [Setting.Move_Animations]: 1,
@@ -93,7 +100,7 @@ export const settingDefaults: SettingDefaults = {
   [Setting.Vibration]: 0
 };
 
-export const reloadSettings: Setting[] = [Setting.UI_Theme, Setting.Language, Setting.Sprite_Set];
+export const reloadSettings: Setting[] = [Setting.UI_Theme, Setting.Language, Setting.Sprite_Set, Setting.Candy_Upgrade_Display];
 
 export function setSetting(scene: BattleScene, setting: Setting, value: integer): boolean {
   switch (setting) {
@@ -127,6 +134,16 @@ export function setSetting(scene: BattleScene, setting: Setting, value: integer)
   case Setting.Enable_Retries:
     scene.enableRetries = settingOptions[setting][value] === "On";
     break;
+  case Setting.Candy_Upgrade_Notification:
+    if (scene.candyUpgradeNotification === value) {
+      break;
+    }
+
+    scene.candyUpgradeNotification = value;
+    scene.eventTarget.dispatchEvent(new CandyUpgradeNotificationChangedEvent(value));
+    break;
+  case Setting.Candy_Upgrade_Display:
+    scene.candyUpgradeDisplay = value;
   case Setting.Money_Format:
     switch (settingOptions[setting][value]) {
     case "Normal":