Miku: clamp invalid fire rate values

Author: vulpya

BUGS.md

@@ -10,3 +10,4 @@
 - [x] When using 'Monstros Lung' as Tainted Miku your tear rate will sky rocket to 120. Reported by DoomSlammer
 - [x] Using a Chaos Card as either version of Hatsune Miku instead throws a default musical note projectile (colorful/rainbow for regular, gray-scale/monochrome for tainted) that doesn't instantly kill entities. Reported by RDW
 - [ ] Subtle visual glitch on the first frame of a Glitch Note without a variant.
+- [ ] Fix Spirit Sword and Mom's Knife not working with Tainted Miku's note system switch.

src/characters/Character.ts

@@ -1,9 +1,8 @@
 import type { EIDExtended } from "../compat/EID";
 import { Feature } from "../Feature";
 
-export interface PlayerData {
-  fireDelayInit?: boolean;
-}
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-empty-interface
+export interface PlayerData {}
 
 /** Abstract base class representing a custom character. */
 export abstract class Character extends Feature {

src/characters/Miku/MikuCharacter.ts

@@ -12,12 +12,11 @@ import {
 } from "isaacscript-common";
 import type { EIDExtended } from "../../compat/EID";
 import { CollectibleTypeCustom } from "../../items/enum";
-import { setFireRate } from "../../util/calc";
 import { getData } from "../../util/data";
 import { Debugger } from "../../util/debug";
 import type { PlayerData } from "../Character";
 import { Character } from "../Character";
-import { isMiku, PlayerTypeCustom } from "../enum";
+import { PlayerTypeCustom } from "../enum";
 
 export interface MikuPlayerData extends PlayerData {
   hasIdol?: boolean;
@@ -30,11 +29,11 @@ const BIRTHRIGHT_DESC =
 const ACTIVE = CollectibleTypeCustom.MICROPHONE;
 const NULL_ITEM = CollectibleTypeCustom.MIKU_IDOL;
 const HAIR = Isaac.GetCostumeIdByPath("gfx/characters/Character_MikuHead.anm2");
-const TEARS_STAT = 0.5;
 
 export const MIKU_STATS = new ReadonlyMap<CacheFlag, number>([
   [CacheFlag.SPEED, 1.2],
   [CacheFlag.DAMAGE, 2.8],
+  [CacheFlag.FIRE_DELAY, 3.33],
 ]);
 
 export class MikuCharacter extends Character {
@@ -74,15 +73,6 @@ export class MikuCharacter extends Character {
     super.postPlayerInit(player);
   }
 
-  @Callback(ModCallback.EVALUATE_CACHE, CacheFlag.FIRE_DELAY)
-  override cacheFireDelay(player: EntityPlayer): void {
-    if (!isMiku(player)) {
-      return;
-    }
-
-    setFireRate<MikuPlayerData>(player, TEARS_STAT);
-  }
-
   /**
    * Sets up **External Item Descriptions (EID)** compatibility for Miku.
    *

src/characters/Miku/MikuTaintedCharacter.ts

@@ -39,7 +39,8 @@ import {
 import type { GlitchNoteTearData } from "../../entities/tears/GlitchNoteTear/GlitchNoteTear";
 import { CollectibleTypeCustom } from "../../items/enum";
 import { mod } from "../../mod";
-import { getFireRateMultiplier, setFireRate } from "../../util/calc";
+import { maxFireDelayToTears, tearsToMaxFireDelay } from "../../util/calc";
+import { ISAAC_STATS } from "../../util/const";
 import { updateCollectibleCostumes } from "../../util/costumes";
 import { getData } from "../../util/data";
 import { Debugger } from "../../util/debug";
@@ -64,7 +65,6 @@ 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 TEARS_STAT = -0.6;
 const NOTE_DROP_CHANCE = 65;
 
 const ITEM_REPLACEMENTS: Partial<Record<CollectibleType, CollectibleType>> = {
@@ -77,14 +77,11 @@ const ITEM_COSTUMES: Partial<Record<CollectibleType, CollectibleType>> = {
   [CollectibleTypeCustom.DR_FETUS_NOTE]: CollectibleType.DR_FETUS,
 } as const;
 
-const FIRE_RATE_ITEM_MULTIPLIERS: Partial<Record<CollectibleType, number>> = {
-  [CollectibleType.MONSTROS_LUNG]: 0.35,
-} as const;
-
 export const MIKU_B_STATS = new ReadonlyMap<CacheFlag, float>([
-  [CacheFlag.DAMAGE, 3.8],
-  [CacheFlag.LUCK, -1],
+  [CacheFlag.DAMAGE, 4.35],
+  [CacheFlag.LUCK, -1.5],
   [CacheFlag.COLOR, 2],
+  [CacheFlag.FIRE_DELAY, 2.13],
 ]);
 
 export class MikuTaintedCharacter extends Character {
@@ -140,21 +137,18 @@ export class MikuTaintedCharacter extends Character {
   )
   override postPlayerInitFirst(player: EntityPlayer): void {
     const playerData = getData<TaintedMikuData>(player);
-    playerData.erased = [];
-    playerData.notes = [];
+    playerData.hasIdol = false;
     playerData.useNotes = false;
+    playerData.notes = [];
+    playerData.erased = [];
     playerData.unlockedNotes = [];
-    playerData.hasIdol = false;
 
     player.AddNullCostume(HAIR);
     Debugger.char(`${NAME} (Tainted)`, `Applied null costume: ${HAIR}`);
 
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (!playerData.hasIdol) {
-      player.AddCollectible(NULL_ITEM, 0);
-      playerData.hasIdol = true;
-      Debugger.char(NAME, `Applied null item: ${NULL_ITEM}.`);
-    }
+    player.AddCollectible(NULL_ITEM, 0);
+    playerData.hasIdol = true;
+    Debugger.char(NAME, `Applied null item: ${NULL_ITEM}.`);
 
     if (!player.HasCollectible(POCKET_ACTIVE)) {
       player.SetPocketActiveItem(POCKET_ACTIVE, ActiveSlot.POCKET, false);
@@ -229,16 +223,10 @@ export class MikuTaintedCharacter extends Character {
       return;
     }
 
-    const multiplier = getFireRateMultiplier(
-      player,
-      FIRE_RATE_ITEM_MULTIPLIERS,
-    );
-
-    if (multiplier === -1) {
-      return;
+    const tears = maxFireDelayToTears(player.MaxFireDelay);
+    if (tears >= ISAAC_STATS.TEARS_THRESHOLD) {
+      player.MaxFireDelay = tearsToMaxFireDelay(0.1);
     }
-
-    setFireRate<TaintedMikuData>(player, TEARS_STAT, multiplier);
   }
 
   @Callback(ModCallback.POST_TEAR_INIT)

src/util/calc.ts

@@ -1,50 +1,4 @@
-import type { CollectibleType } from "isaac-typescript-definitions";
-import type { PlayerData } from "../characters/Character";
-import { getData } from "./data";
+export const maxFireDelayToTears = (maxFireDelay: number): number =>
+  30 / (maxFireDelay + 1);
 
-const tearsToMaxFireDelay = (tears: number): number => 30 / tears - 1;
-
-export const getFireRateMultiplier = (
-  player: EntityPlayer,
-  entries: Partial<Record<CollectibleType, number>>,
-): number => {
-  let multiplier = 1;
-
-  for (const [item, value] of Object.entries(entries) as Array<
-    [string, number | undefined]
-  >) {
-    const collectible = Number(item) as CollectibleType;
-
-    if (value !== undefined && player.HasCollectible(collectible)) {
-      multiplier *= value;
-    }
-  }
-
-  return multiplier;
-};
-
-/**
- * Sets base stat the MaxFireDelay for the player. It calculates the tears value to the fire delay.
- *
- * @param player The player the fire rate should be applied too.
- * @param tears Tear Rate that should be applied.
- */
-export const setFireRate = <T extends PlayerData>(
-  player: EntityPlayer,
-  tears: number,
-  multiplier = 1,
-): void => {
-  const data = getData<T>(player);
-
-  if (!(data.fireDelayInit ?? false)) {
-    const currentTears = 30 / (player.MaxFireDelay + 1);
-
-    const modifiedTears = tears * multiplier;
-
-    const newTears = currentTears + modifiedTears;
-
-    const clampedTears = Math.max(0.1, newTears);
-
-    player.MaxFireDelay = tearsToMaxFireDelay(clampedTears);
-  }
-};
+export const tearsToMaxFireDelay = (tears: number): number => 30 / tears - 1;

src/util/const.ts

@@ -0,0 +1,3 @@
+export const ISAAC_STATS = {
+  TEARS_THRESHOLD: 120,
+} as const;