Miku: add item blacklist for glitch notes mode

Author: vulpya

src/characters/Miku/MikuTaintedCharacter.ts

@@ -11,7 +11,6 @@ import {
   PlayerVariant,
   SoundEffect,
 } from "isaac-typescript-definitions";
-import type { SaveData } from "isaacscript-common";
 import {
   anyPlayerIs,
   Callback,
@@ -47,16 +46,31 @@ import { Debugger } from "../../util/debug";
 import { setTearColor } from "../../util/effects";
 import { eraseEnemies, getEnemyKey } from "../../util/enemies";
 import { rollWeighted } from "../../util/rng";
+import type { ModSaveData } from "../../util/save";
 import { SAVE_DATA } from "../../util/save";
 import { Character } from "../Character";
 import { isMiku, PlayerTypeCustom } from "../enum";
 import type { MikuPlayerData } from "./MikuCharacter";
+import {
+  isNoteItemDisabled,
+  MikuAttackMode as MikuNoteMode,
+  setMikuAttackMode,
+} from "./mikuHelper";
 
 export interface TaintedMikuData extends MikuPlayerData {
-  useNotes?: boolean;
+  attackMode?: MikuNoteMode;
+  notes?: NoteInstance[];
+  unlockedNotes?: NotePickupSubType[];
+  erased?: string[];
+  storedCollectibles?: Set<CollectibleType>;
+}
+
+export interface TaintedMikuSaveData {
+  attackMode?: MikuNoteMode;
   notes?: NoteInstance[];
   unlockedNotes?: NotePickupSubType[];
   erased?: string[];
+  storedCollectibles?: CollectibleType[];
 }
 
 const NAME = "Miku";
@@ -65,7 +79,7 @@ const BIRTHRIGHT_DESC = "TODO";
 const HAIR = Isaac.GetCostumeIdByPath("gfx/characters/Character_MikuHead.anm2");
 const POCKET_ACTIVE = CollectibleTypeCustom.BROKEN_VOICE;
 const NULL_ITEM = CollectibleTypeCustom.MIKU_IDOL;
-const NOTE_DROP_CHANCE = 65;
+const NOTE_DROP_CHANCE = 45;
 
 const ITEM_REPLACEMENTS: Partial<Record<CollectibleType, CollectibleType>> = {
   [CollectibleType.BRIMSTONE]: CollectibleTypeCustom.BRIMSTONE_NOTE,
@@ -92,31 +106,35 @@ export class MikuTaintedCharacter extends Character {
   /** Font for the uses text of the notes. */
   private font: Font | undefined = undefined;
 
-  @CallbackCustom(ModCallbackCustom.POST_GAME_STARTED_REORDERED, undefined)
+  @CallbackCustom(ModCallbackCustom.POST_GAME_STARTED_REORDERED, true)
   override onGameStart(isContinued: boolean): void {
     if (!isContinued || !mod.HasData()) {
       return;
     }
 
-    const loaded = jsonDecode(mod.LoadData()) as SaveData;
+    const loaded = jsonDecode(mod.LoadData()) as unknown as ModSaveData;
 
     Object.assign(SAVE_DATA, loaded);
   }
 
   @Callback(ModCallback.PRE_GAME_EXIT)
   override onGameExit(): void {
-    SAVE_DATA.players = {};
+    SAVE_DATA.mikuBs = {};
 
     const players = getPlayersOfType(PlayerTypeCustom.MIKU_B);
     for (const player of players) {
       const playerData = getData<TaintedMikuData>(player);
 
-      const { erased, notes, useNotes } = playerData;
+      const { erased, notes, attackMode, storedCollectibles } = playerData;
 
-      SAVE_DATA.players[player.ControllerIndex.toString()] = {
+      SAVE_DATA.mikuBs[player.ControllerIndex.toString()] = {
+        attackMode: attackMode ?? MikuNoteMode.GLITCH,
         erased: erased ? [...erased] : [],
         notes: notes ? [...notes] : [],
-        useNotes: useNotes ?? false,
+        unlockedNotes: playerData.unlockedNotes
+          ? [...playerData.unlockedNotes]
+          : [],
+        storedCollectibles: storedCollectibles ? [...storedCollectibles] : [],
       };
     }
 
@@ -138,10 +156,11 @@ export class MikuTaintedCharacter extends Character {
   override postPlayerInitFirst(player: EntityPlayer): void {
     const playerData = getData<TaintedMikuData>(player);
     playerData.hasIdol = false;
-    playerData.useNotes = false;
+    playerData.attackMode = MikuNoteMode.GLITCH;
     playerData.notes = [];
     playerData.erased = [];
     playerData.unlockedNotes = [];
+    playerData.storedCollectibles = new Set();
 
     player.AddNullCostume(HAIR);
     Debugger.char(`${NAME} (Tainted)`, `Applied null costume: ${HAIR}`);
@@ -170,17 +189,25 @@ export class MikuTaintedCharacter extends Character {
       return;
     }
 
-    const saved = SAVE_DATA.players[player.ControllerIndex.toString()];
+    const saved = SAVE_DATA.mikuBs[player.ControllerIndex.toString()];
     if (!saved) {
       return;
     }
 
     const playerData = getData<TaintedMikuData>(player);
-    playerData.erased = saved.erased;
-    playerData.notes = saved.notes;
-    playerData.useNotes = saved.useNotes;
 
-    this.postPlayerInit(player);
+    playerData.erased = saved.erased ?? [];
+    playerData.notes = saved.notes ?? [];
+    playerData.unlockedNotes = saved.unlockedNotes ?? [];
+    playerData.attackMode = saved.attackMode ?? MikuNoteMode.GLITCH;
+
+    playerData.storedCollectibles = new Set(saved.storedCollectibles ?? []);
+
+    for (const collectible of playerData.storedCollectibles) {
+      if (!player.HasCollectible(collectible)) {
+        player.AddCollectible(collectible);
+      }
+    }
   }
 
   @CallbackCustom(
@@ -190,7 +217,7 @@ export class MikuTaintedCharacter extends Character {
   )
   override postPlayerUpdate(player: EntityPlayer): void {
     const playerData = getData<TaintedMikuData>(player);
-    const { notes, useNotes } = playerData;
+    const { notes } = playerData;
 
     if (!notes || notes.length === 0) {
       return;
@@ -201,7 +228,11 @@ export class MikuTaintedCharacter extends Character {
       player.ControllerIndex,
     );
 
-    if (!(useNotes ?? false) && isDropping && notes.length > 1) {
+    if (
+      playerData.attackMode === MikuNoteMode.VOICES
+      && isDropping
+      && notes.length > 1
+    ) {
       const firstNote = notes.shift();
       if (firstNote) {
         notes.push(firstNote);
@@ -251,9 +282,13 @@ export class MikuTaintedCharacter extends Character {
     }
 
     const playerData = getData<TaintedMikuData>(player);
-    const { notes, useNotes } = playerData;
+    const { notes, attackMode } = playerData;
+
+    if (attackMode === MikuNoteMode.GLITCH) {
+      return;
+    }
 
-    if ((useNotes ?? false) || !notes || notes.length === 0) {
+    if (!notes || notes.length === 0) {
       return;
     }
 
@@ -311,7 +346,7 @@ export class MikuTaintedCharacter extends Character {
 
     for (const player of players) {
       const playerData = getData<TaintedMikuData>(player);
-      const { notes, useNotes } = playerData;
+      const { notes, attackMode } = playerData;
       if (!notes || notes.length === 0) {
         continue;
       }
@@ -380,7 +415,7 @@ export class MikuTaintedCharacter extends Character {
             : noteConfig.color;
 
         this.noteSprite.Color =
-          (useNotes ?? false)
+          attackMode === MikuNoteMode.GLITCH
             ? Color(
                 baseColor.R * 0.35,
                 baseColor.G * 0.35,
@@ -404,7 +439,11 @@ export class MikuTaintedCharacter extends Character {
       // Render 'selected' note above player.
       const activeNote = notes[0];
 
-      if (!(useNotes ?? false) && activeNote && !isPausedCutscene) {
+      if (
+        attackMode === MikuNoteMode.VOICES
+        && activeNote
+        && !isPausedCutscene
+      ) {
         const noteConfig = NOTE_TYPE_DATA[activeNote.subType];
         const screenPos: Vector = Isaac.WorldToScreen(player.Position);
 
@@ -569,21 +608,18 @@ export class MikuTaintedCharacter extends Character {
       return undefined;
     }
 
+    const data = getData<TaintedMikuData>(player);
+
     const itemID = pickup.SubType as CollectibleType;
     const synergyNote = ITEM_SYNERGIES[itemID];
     const replaceItem = ITEM_REPLACEMENTS[itemID];
 
-    // FIXME: Solution until I find a better one...
-    if (itemID === CollectibleType.LUDOVICO_TECHNIQUE) {
-      player.AddCollectible(CollectibleType.TECH_5);
-      return undefined;
-    }
+    this.checkDisabledItem(player, itemID);
 
     if (synergyNote === undefined || replaceItem === undefined) {
       return undefined;
     }
 
-    const data = getData<TaintedMikuData>(player);
     data.unlockedNotes ??= [];
 
     if (!data.unlockedNotes.includes(synergyNote)) {
@@ -644,6 +680,14 @@ export class MikuTaintedCharacter extends Character {
       () => anyPlayerIs(PlayerTypeCustom.MIKU_B),
     );
 
+    appendToDescription(
+      eid,
+      "Mom's Knife",
+      PlayerTypeCustom.MIKU_B,
+      `#{{Player${PlayerTypeCustom.MIKU_B}}} {{Warning}} Tainted Miku can use the knife only in her glitched mode`,
+      () => anyPlayerIs(PlayerTypeCustom.MIKU_B),
+    );
+
     appendToDescription(
       eid,
       "Dr. Fetus",
@@ -652,4 +696,20 @@ export class MikuTaintedCharacter extends Character {
       () => anyPlayerIs(PlayerTypeCustom.MIKU_B),
     );
   }
+
+  private checkDisabledItem(
+    player: EntityPlayer,
+    itemID: CollectibleType,
+  ): void {
+    const data = getData<TaintedMikuData>(player);
+
+    if (isNoteItemDisabled(itemID) && data.attackMode !== MikuNoteMode.GLITCH) {
+      setMikuAttackMode(player, MikuNoteMode.GLITCH);
+
+      Debugger.char(
+        NAME,
+        `Switched to Glitch mode because ${itemID} is disabled in Notes mode.`,
+      );
+    }
+  }
 }

src/characters/Miku/mikuHelper.ts

@@ -0,0 +1,48 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+import { getData } from "../../util/data";
+import type { TaintedMikuData } from "./MikuTaintedCharacter";
+
+export enum MikuAttackMode {
+  GLITCH,
+  VOICES,
+}
+
+// eslint-disable-next-line complete/require-capital-read-only
+const NOTE_DISABLED_ITEMS: CollectibleType[] = [
+  CollectibleType.MOMS_KNIFE,
+  CollectibleType.SPIRIT_SWORD,
+  CollectibleType.LUDOVICO_TECHNIQUE,
+] as const;
+
+export const setMikuAttackMode = (
+  player: EntityPlayer,
+  mode: MikuAttackMode,
+): void => {
+  const playerData = getData<TaintedMikuData>(player);
+
+  if (playerData.attackMode === mode) {
+    return;
+  }
+
+  playerData.storedCollectibles ??= new Set();
+
+  if (mode === MikuAttackMode.VOICES) {
+    for (const item of NOTE_DISABLED_ITEMS) {
+      if (player.HasCollectible(item)) {
+        playerData.storedCollectibles.add(item);
+        player.RemoveCollectible(item);
+      }
+    }
+  } else {
+    for (const item of playerData.storedCollectibles) {
+      player.AddCollectible(item);
+    }
+
+    playerData.storedCollectibles = new Set();
+  }
+
+  playerData.attackMode = mode;
+};
+
+export const isNoteItemDisabled = (collectible: CollectibleType): boolean =>
+  NOTE_DISABLED_ITEMS.includes(collectible);

src/items/Miku/MikuB/BrokenVoiceItem/BrokenVoiceItem.ts

@@ -3,9 +3,13 @@ import type {
   CollectibleType,
   UseFlag,
 } from "isaac-typescript-definitions";
-import { ModCallback, SoundEffect } from "isaac-typescript-definitions";
+import { ModCallback } from "isaac-typescript-definitions";
 import { Callback } from "isaacscript-common";
 import { isMiku } from "../../../../characters/enum";
+import {
+  MikuAttackMode,
+  setMikuAttackMode,
+} from "../../../../characters/Miku/mikuHelper";
 import type { TaintedMikuData } from "../../../../characters/Miku/MikuTaintedCharacter";
 import type { EIDExtended } from "../../../../compat/EID";
 import { getData } from "../../../../util/data";
@@ -40,16 +44,13 @@ export class BrokenVoiceItem extends ActiveItem {
   ): UseItemResult {
     if (isMiku(player, true)) {
       const playerData = getData<TaintedMikuData>(player);
-      if (playerData.notes && playerData.notes.length > 0) {
-        playerData.useNotes = !(playerData.useNotes ?? false);
-        SFXManager().Play(
-          SoundEffect.STATIC,
-          1,
-          2,
-          false,
-          playerData.useNotes ? 1 : 1.75,
-        );
-      }
+
+      setMikuAttackMode(
+        player,
+        playerData.attackMode === MikuAttackMode.GLITCH
+          ? MikuAttackMode.VOICES
+          : MikuAttackMode.GLITCH,
+      );
     }
 
     return {

src/util/save.ts

@@ -1,9 +1,10 @@
-import type { TaintedMikuData } from "../characters/Miku/MikuTaintedCharacter";
+import type { SaveData } from "isaacscript-common";
+import type { TaintedMikuSaveData } from "../characters/Miku/MikuTaintedCharacter";
 
-interface ModSaveData {
-  players: Record<string, TaintedMikuData>;
+export interface ModSaveData extends SaveData {
+  mikuBs: Record<string, TaintedMikuSaveData>;
 }
 
 export const SAVE_DATA: ModSaveData = {
-  players: {},
+  mikuBs: {},
 } as const;