isaacscript-common 87.9.5 → 87.9.7

package/src/functions/bosses.ts

@@ -91,6 +91,27 @@ export function getAllNonStoryBosses(): readonly BossID[] {
   return NON_STORY_BOSSES;
 }
 
+/**
+ * Helper function to get all of the bosses in the room.
+ *
+ * @param entityType Optional. If specified, will only get the bosses that match the type. Default
+ *                   is -1, which matches every type.
+ * @param variant Optional. If specified, will only get the bosses that match the variant. Default
+ *                is -1, which matches every variant.
+ * @param subType Optional. If specified, will only get the bosses that match the sub-type. Default
+ *                is -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
+ */
+export function getBosses(
+  entityType?: EntityType,
+  variant?: int,
+  subType?: int,
+  ignoreFriendly = false,
+): readonly EntityNPC[] {
+  const npcs = getNPCs(entityType, variant, subType, ignoreFriendly);
+  return npcs.filter((npc) => npc.IsBoss());
+}
+
 /**
  * Helper function to get the boss ID corresponding to the current room. Returns undefined if the
  * current room is not a Boss Room.
@@ -179,27 +200,6 @@ export function getBossStageIDs(bossID: BossID): ReadonlySet<StageID> {
   return BOSS_ID_TO_STAGE_IDS[bossID];
 }
 
-/**
- * Helper function to get all of the bosses in the room.
- *
- * @param entityType Optional. If specified, will only get the bosses that match the type. Default
- *                   is -1, which matches every type.
- * @param variant Optional. If specified, will only get the bosses that match the variant. Default
- *                is -1, which matches every variant.
- * @param subType Optional. If specified, will only get the bosses that match the sub-type. Default
- *                is -1, which matches every sub-type.
- * @param ignoreFriendly Optional. Default is false.
- */
-export function getBosses(
-  entityType?: EntityType,
-  variant?: int,
-  subType?: int,
-  ignoreFriendly = false,
-): readonly EntityNPC[] {
-  const npcs = getNPCs(entityType, variant, subType, ignoreFriendly);
-  return npcs.filter((npc) => npc.IsBoss());
-}
-
 export function getEntityTypeVariantFromBossID(
   bossID: BossID,
 ): readonly [EntityType, int] {
@@ -222,40 +222,6 @@ export function isSin(npc: EntityNPC): boolean {
   return SIN_ENTITY_TYPES_SET.has(npc.Type);
 }
 
-function getNumBossSegments(
-  entityType: EntityType,
-  variant: int,
-  numSegments: int | undefined,
-) {
-  if (numSegments !== undefined) {
-    return numSegments;
-  }
-
-  switch (entityType) {
-    // 28
-    case EntityType.CHUB: {
-      // Chub is always composed of 3 segments.
-      return 3;
-    }
-
-    // 69
-    case EntityType.LOKI: {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
-      return variant === LokiVariant.LOKII ? 2 : 1;
-    }
-
-    // 237
-    case EntityType.GURGLING: {
-      // Gurglings & Turdlings are always encountered in groups of 2.
-      return 2;
-    }
-
-    default: {
-      return DEFAULT_BOSS_MULTI_SEGMENTS;
-    }
-  }
-}
-
 /**
  * Helper function to spawn a boss.
  *
@@ -337,3 +303,37 @@ export function spawnBossWithSeed(
     numSegments,
   );
 }
+
+function getNumBossSegments(
+  entityType: EntityType,
+  variant: int,
+  numSegments: int | undefined,
+) {
+  if (numSegments !== undefined) {
+    return numSegments;
+  }
+
+  switch (entityType) {
+    // 28
+    case EntityType.CHUB: {
+      // Chub is always composed of 3 segments.
+      return 3;
+    }
+
+    // 69
+    case EntityType.LOKI: {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+      return variant === LokiVariant.LOKII ? 2 : 1;
+    }
+
+    // 237
+    case EntityType.GURGLING: {
+      // Gurglings & Turdlings are always encountered in groups of 2.
+      return 2;
+    }
+
+    default: {
+      return DEFAULT_BOSS_MULTI_SEGMENTS;
+    }
+  }
+}

package/src/functions/challenges.ts

@@ -30,13 +30,15 @@ import { log } from "./log";
  * Under the hood, this function executes the `challenge 0` console command.
  */
 export function clearChallenge(): void {
-  if (onAnyChallenge()) {
-    const command = `challenge ${Challenge.NULL}`;
-    log(
-      `Restarting the run to clear the current challenge with a console command of: ${command}`,
-    );
-    Isaac.ExecuteCommand(command);
+  if (!onAnyChallenge()) {
+    return;
   }
+
+  const command = `challenge ${Challenge.NULL}`;
+  log(
+    `Restarting the run to clear the current challenge with a console command of: ${command}`,
+  );
+  Isaac.ExecuteCommand(command);
 }
 
 /**
@@ -127,11 +129,13 @@ export function onChallenge(...challenges: readonly Challenge[]): boolean {
  * Under the hood, this function executes the `challenge 0` console command.
  */
 export function setChallenge(challenge: Challenge): void {
-  if (!onChallenge(challenge)) {
-    const command = `challenge ${challenge}`;
-    log(
-      `Restarting the run to set a challenge with a console command of: ${command}`,
-    );
-    Isaac.ExecuteCommand(command);
+  if (onChallenge(challenge)) {
+    return;
   }
+
+  const command = `challenge ${challenge}`;
+  log(
+    `Restarting the run to set a challenge with a console command of: ${command}`,
+  );
+  Isaac.ExecuteCommand(command);
 }

package/src/functions/characters.ts

@@ -88,7 +88,7 @@ export function getCharacterDamageMultiplier(
   character: PlayerType,
   hasWhoreOfBabylon = false,
 ): float {
-  if (character === PlayerType.EVE && hasWhoreOfBabylon) {
+  if (hasWhoreOfBabylon && character === PlayerType.EVE) {
     return 1;
   }
 

package/src/functions/charge.ts

@@ -105,6 +105,25 @@ export function addRoomClearCharge(
   }
 }
 
+/**
+ * Helper function to add a charge to every player's active item, emulating what happens when a room
+ * is cleared.
+ *
+ * This function will take the following things into account:
+ * - L rooms and 2x2 rooms granting a double charge
+ * - The Battery
+ * - AAA Battery
+ *
+ * @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
+ *                            room for the purposes of calculating how much charge to grant. Default
+ *                            is true.
+ */
+export function addRoomClearCharges(bigRoomDoubleCharge = true): void {
+  for (const player of getPlayers()) {
+    addRoomClearCharge(player, bigRoomDoubleCharge);
+  }
+}
+
 /**
  * Helper function to add a charge to one of a player's active items, emulating what happens when a
  * room is cleared.
@@ -158,44 +177,6 @@ export function addRoomClearChargeToSlot(
   addCharge(player, activeSlot, numCharges, playSoundEffect);
 }
 
-/**
- * The AAA Battery should grant an extra charge when the active item is one away from being fully
- * charged.
- */
-function getChargesToAddWithAAAModifier(
-  player: EntityPlayer,
-  activeSlot: ActiveSlot,
-  chargesToAdd: int,
-) {
-  const hasAAABattery = player.HasTrinket(TrinketType.AAA_BATTERY);
-  if (!hasAAABattery) {
-    return chargesToAdd;
-  }
-
-  const chargesAwayFromMax = getChargesAwayFromMax(player, activeSlot);
-  const AAABatteryShouldApply = chargesToAdd === chargesAwayFromMax - 1;
-  return AAABatteryShouldApply ? chargesToAdd + 1 : chargesToAdd;
-}
-
-/**
- * Helper function to add a charge to every player's active item, emulating what happens when a room
- * is cleared.
- *
- * This function will take the following things into account:
- * - L rooms and 2x2 rooms granting a double charge
- * - The Battery
- * - AAA Battery
- *
- * @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
- *                            room for the purposes of calculating how much charge to grant. Default
- *                            is true.
- */
-export function addRoomClearCharges(bigRoomDoubleCharge = true): void {
-  for (const player of getPlayers()) {
-    addRoomClearCharge(player, bigRoomDoubleCharge);
-  }
-}
-
 /**
  * Helper function to get the amount of charges away from the maximum charge that a particular
  * player is.
@@ -298,6 +279,25 @@ export function playChargeSoundEffect(
   sfxManager.Play(chargeSoundEffect);
 }
 
+/**
+ * The AAA Battery should grant an extra charge when the active item is one away from being fully
+ * charged.
+ */
+function getChargesToAddWithAAAModifier(
+  player: EntityPlayer,
+  activeSlot: ActiveSlot,
+  chargesToAdd: int,
+) {
+  const hasAAABattery = player.HasTrinket(TrinketType.AAA_BATTERY);
+  if (!hasAAABattery) {
+    return chargesToAdd;
+  }
+
+  const chargesAwayFromMax = getChargesAwayFromMax(player, activeSlot);
+  const AAABatteryShouldApply = chargesToAdd === chargesAwayFromMax - 1;
+  return AAABatteryShouldApply ? chargesToAdd + 1 : chargesToAdd;
+}
+
 function shouldPlayFullRechargeSound(
   player: EntityPlayer,
   activeSlot: ActiveSlot,

package/src/functions/collectibles.ts

@@ -171,8 +171,7 @@ export function getCollectibleDescription(
   // "ItemConfigItem.Description" is bugged with vanilla items on patch v1.7.6, so we use a
   // hard-coded map as a workaround.
   const collectibleDescription = COLLECTIBLE_DESCRIPTIONS[collectibleType] as
-    | string
-    | undefined;
+    string | undefined;
   if (collectibleDescription !== undefined) {
     return collectibleDescription;
   }
@@ -221,12 +220,12 @@ export function getCollectibleDevilHeartPrice(
     collectibleOrCollectibleType,
     "getCollectibleDevilHeartPrice",
   );
-  const maxHearts = player.GetMaxHearts();
 
   if (collectibleType === CollectibleType.NULL) {
     return 0;
   }
 
+  const maxHearts = player.GetMaxHearts();
   if (maxHearts === 0) {
     return PickupPrice.THREE_SOUL_HEARTS;
   }
@@ -361,8 +360,7 @@ export function getCollectibleName(
   // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded map
   // as a workaround.
   const collectibleName = COLLECTIBLE_NAMES[collectibleType] as
-    | string
-    | undefined;
+    string | undefined;
   if (collectibleName !== undefined) {
     return collectibleName;
   }
@@ -776,6 +774,17 @@ export function setCollectibleSprite(
   }
 }
 
+/**
+ * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
+ * the build has been rerolled.
+ */
+export function setCollectiblesRerolledForItemTracker(): void {
+  // This cannot use the "log" function since the prefix will prevent the Rebirth Item Tracker from
+  // recognizing the message. The number here does not matter since the tracker does not check for a
+  // specific number.
+  Isaac.DebugString("Added 3 Collectibles");
+}
+
 /**
  * Helper function to change the collectible on a pedestal. Simply updating the `SubType` field is
  * not sufficient because the sprite will not change.
@@ -812,17 +821,6 @@ export function setCollectibleSubType(
   );
 }
 
-/**
- * Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
- * the build has been rerolled.
- */
-export function setCollectiblesRerolledForItemTracker(): void {
-  // This cannot use the "log" function since the prefix will prevent the Rebirth Item Tracker from
-  // recognizing the message. The number here does not matter since the tracker does not check for a
-  // specific number.
-  Isaac.DebugString("Added 3 Collectibles");
-}
-
 function getCollectibleTypeFromArg(
   collectibleOrCollectibleType: EntityPickup | CollectibleType,
   functionName: string,

package/src/functions/color.ts

@@ -11,7 +11,7 @@ import {
 import { isTable } from "./types";
 import { assertDefined } from "./utils";
 
-export type SerializedColor = LuaMap<string, unknown> & {
+export type SerializedColor = Readonly<LuaMap<string, unknown>> & {
   readonly __serializedColorBrand: symbol;
   readonly __kind: CopyableIsaacAPIClassType.COLOR;
 };

package/src/functions/decorators.ts

@@ -1,5 +1,3 @@
-/* eslint-disable jsdoc/escape-inline-tags */
-
 /**
  * If you decide to structure your mod as a set of feature classes, you can use decorators to
  * automatically register callbacks.
@@ -94,6 +92,7 @@ export function PriorityCallback<T extends ModCallback>(
   ): void => {
     // First, prepare the arguments for the `Mod.AddPriorityCallback` method.
     const methodName = propertyKey as keyof ModFeature;
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const method = target[methodName] as AddCallbackParameters[T][0];
     const callbackTuple = [modCallback, priority, method, optionalArgs];
 
@@ -101,8 +100,7 @@ export function PriorityCallback<T extends ModCallback>(
     // properties, which are located on the "constructor" table. Thus, we store the callback
     // arguments for later.
     const constructor = target.constructor as unknown as
-      | Record<string, unknown>
-      | undefined;
+      Record<string, unknown> | undefined;
 
     if (constructor === undefined) {
       const tstlClassName = getTSTLClassName(target) ?? "Unknown";
@@ -142,6 +140,7 @@ export function PriorityCallbackCustom<T extends ModCallbackCustom>(
   ): void => {
     // First, prepare the arguments for the `Mod.AddCallbackCustom` method.
     const methodName = propertyKey as keyof ModFeature;
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const method = target[methodName] as AddCallbackParametersCustom[T][0];
     const callbackTuple = [modCallbackCustom, priority, method, optionalArgs];
 
@@ -149,8 +148,7 @@ export function PriorityCallbackCustom<T extends ModCallbackCustom>(
     // properties, which are located on the "constructor" table. Thus, we store the callback
     // arguments for later.
     const constructor = target.constructor as unknown as
-      | Record<string, unknown>
-      | undefined;
+      Record<string, unknown> | undefined;
 
     if (constructor === undefined) {
       const tstlClassName = getTSTLClassName(target) ?? "Unknown";