isaacscript-common 87.5.0 → 87.6.0

package/src/functions/merge.ts

@@ -131,7 +131,7 @@ function mergeSerializedArray(
 }
 
 function mergeSerializedTSTLObject(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   oldObject: Map<AnyNotNil, unknown> | Set<AnyNotNil>,
   newTable: LuaMap<AnyNotNil, unknown>,
   traversalDescription: string,

package/src/functions/minimap.ts

@@ -91,9 +91,7 @@ export function getRoomDisplayFlags(
   roomGridIndex?: int,
   minimapAPI = true,
 ): BitFlags<DisplayFlag> {
-  if (roomGridIndex === undefined) {
-    roomGridIndex = getRoomGridIndex();
-  }
+  roomGridIndex ??= getRoomGridIndex();
 
   if (MinimapAPI === undefined || !minimapAPI) {
     const roomDescriptor = getRoomDescriptor(roomGridIndex);
@@ -217,9 +215,7 @@ export function setRoomDisplayFlags(
   displayFlags: BitFlags<DisplayFlag>,
   updateVisibility = true,
 ): void {
-  if (roomGridIndex === undefined) {
-    roomGridIndex = getRoomGridIndex();
-  }
+  roomGridIndex ??= getRoomGridIndex();
 
   if (MinimapAPI === undefined) {
     const roomDescriptor = getRoomDescriptor(roomGridIndex);

package/src/functions/newArray.ts

@@ -16,7 +16,7 @@ import { repeat } from "./utils";
  * const arrayWithArrays = newArray([0], 20); // Has 20 elements of an array with a 0 in it.
  * ```
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function newArray<T>(defaultValue: T, size: int): T[] {
   const array: T[] = [];
   repeat(size, () => {

package/src/functions/nextStage.ts

@@ -41,16 +41,19 @@ export function getNextStage(): LevelStage {
   // Second, handle the special case of being in a specific off-grid room.
   switch (roomGridIndex) {
     // -8
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     case GridRoom.BLUE_WOMB: {
       return LevelStage.BLUE_WOMB;
     }
 
     // -9
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     case GridRoom.VOID: {
       return LevelStage.VOID;
     }
 
     // -10
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     case GridRoom.SECRET_EXIT: {
       if (repentanceStage) {
         // e.g. From Downpour 2 to Mines 1, etc.
@@ -58,8 +61,8 @@ export function getNextStage(): LevelStage {
       }
 
       if (
-        stage === LevelStage.DEPTHS_2 ||
-        (stage === LevelStage.DEPTHS_1 && hasCurse(LevelCurse.LABYRINTH))
+        stage === LevelStage.DEPTHS_2
+        || (stage === LevelStage.DEPTHS_1 && hasCurse(LevelCurse.LABYRINTH))
       ) {
         // From Depths 2 to Mausoleum 2 through the strange door.
         return LevelStage.DEPTHS_2;
@@ -149,24 +152,25 @@ export function getNextStageType(upwards = false): StageType {
   }
 
   // Second, handle the special case of being in a specific off-grid room.
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   if (roomGridIndex === GridRoom.SECRET_EXIT) {
     return calculateStageTypeRepentance(nextStage);
   }
 
   if (
-    repentanceStage &&
-    (stage === LevelStage.BASEMENT_1 || // 1
-      stage === LevelStage.CAVES_1 || // 3
-      stage === LevelStage.DEPTHS_1 || // 5
-      stage === LevelStage.WOMB_1) // 7
+    repentanceStage
+    && (stage === LevelStage.BASEMENT_1 // 1
+      || stage === LevelStage.CAVES_1 // 3
+      || stage === LevelStage.DEPTHS_1 // 5
+      || stage === LevelStage.WOMB_1) // 7
   ) {
     return calculateStageTypeRepentance(nextStage);
   }
 
   if (
-    repentanceStage &&
-    stage === LevelStage.DEPTHS_2 &&
-    mausoleumHeartKilled
+    repentanceStage
+    && stage === LevelStage.DEPTHS_2
+    && mausoleumHeartKilled
   ) {
     return calculateStageTypeRepentance(nextStage);
   }

package/src/functions/npcDataStructures.ts

@@ -41,7 +41,7 @@ export function defaultMapGetNPC<V, Args extends unknown[]>(
  * `mapSetNPC` helper function.
  */
 export function defaultMapSetNPC<V>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   map: Map<PtrHash, V>,
   npc: EntityNPC,
   value: V,
@@ -54,7 +54,7 @@ export function defaultMapSetNPC<V>(
  * `Map.delete` method if you have a set of this type.
  */
 export function mapDeleteNPC(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   map: Map<PtrHash, unknown>,
   npc: EntityNPC,
 ): boolean {
@@ -123,7 +123,7 @@ export function mapHasNPC<V>(
  * ```
  */
 export function mapSetNPC<V>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   map: Map<PtrHash, V>,
   npc: EntityNPC,
   value: V,
@@ -136,7 +136,7 @@ export function mapSetNPC<V>(
  * Helper function to make using sets with an type of `PtrHash` easier. Use this instead of the
  * `Set.add` method if you have a set of this type.
  */
-// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+// eslint-disable-next-line complete/prefer-readonly-parameter-types
 export function setAddNPC(set: Set<PtrHash>, npc: EntityNPC): void {
   const ptrHash = GetPtrHash(npc);
   set.add(ptrHash);
@@ -146,7 +146,7 @@ export function setAddNPC(set: Set<PtrHash>, npc: EntityNPC): void {
  * Helper function to make using sets with an type of `PtrHash` easier. Use this instead of the
  * `Set.delete` method if you have a set of this type.
  */
-// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+// eslint-disable-next-line complete/prefer-readonly-parameter-types
 export function setDeleteNPC(set: Set<PtrHash>, npc: EntityNPC): boolean {
   const ptrHash = GetPtrHash(npc);
   return set.delete(ptrHash);

package/src/functions/npcs.ts

@@ -131,9 +131,10 @@ export function isDaddyLongLegsChildStompEntity(npc: EntityNPC): boolean {
  */
 export function isDyingDump(npc: EntityNPC): boolean {
   return (
-    npc.Type === EntityType.DUMP &&
-    npc.Variant === DumpVariant.DUMP &&
-    npc.State === NPCState.SPECIAL
+    npc.Type === EntityType.DUMP
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && npc.Variant === DumpVariant.DUMP
+    && npc.State === NPCState.SPECIAL
   );
 }
 
@@ -144,10 +145,11 @@ export function isDyingDump(npc: EntityNPC): boolean {
  */
 export function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean {
   return (
-    npc.Type === EntityType.HOPPER &&
-    npc.Variant === HopperVariant.EGGY &&
-    npc.State === NPCState.SUICIDE &&
-    npc.StateFrame >= EGGY_STATE_FRAME_OF_FINAL_SPIDER
+    npc.Type === EntityType.HOPPER
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && npc.Variant === HopperVariant.EGGY
+    && npc.State === NPCState.SUICIDE
+    && npc.StateFrame >= EGGY_STATE_FRAME_OF_FINAL_SPIDER
   );
 }
 
@@ -159,9 +161,10 @@ export function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean {
  */
 export function isRaglingDeathPatch(npc: EntityNPC): boolean {
   return (
-    npc.Type === EntityType.RAGLING &&
-    npc.Variant === RaglingVariant.RAG_MANS_RAGLING &&
+    npc.Type === EntityType.RAGLING
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && npc.Variant === RaglingVariant.RAG_MANS_RAGLING
     // They go to `STATE_SPECIAL` when they are patches on the ground.
-    npc.State === NPCState.SPECIAL
+    && npc.State === NPCState.SPECIAL
   );
 }

package/src/functions/pickupVariants.ts

@@ -54,8 +54,8 @@ export function isPill(pickup: EntityPickup): pickup is EntityPickupPill {
 /** For `PickupVariant.LIL_BATTERY` (90). */
 export function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery {
   return (
-    pickup.Type === EntityType.PICKUP &&
-    pickup.Variant === PickupVariant.LIL_BATTERY
+    pickup.Type === EntityType.PICKUP
+    && pickup.Variant === PickupVariant.LIL_BATTERY
   );
 }
 
@@ -64,8 +64,8 @@ export function isCollectible(
   pickup: EntityPickup,
 ): pickup is EntityPickupCollectible {
   return (
-    pickup.Type === EntityType.PICKUP &&
-    pickup.Variant === PickupVariant.COLLECTIBLE
+    pickup.Type === EntityType.PICKUP
+    && pickup.Variant === PickupVariant.COLLECTIBLE
   );
 }
 
@@ -79,7 +79,7 @@ export function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard {
 /** For `PickupVariant.TRINKET` (350). */
 export function isTrinket(pickup: EntityPickup): pickup is EntityPickupTrinket {
   return (
-    pickup.Type === EntityType.PICKUP &&
-    pickup.Variant === PickupVariant.TRINKET
+    pickup.Type === EntityType.PICKUP
+    && pickup.Variant === PickupVariant.TRINKET
   );
 }

package/src/functions/playerCollectibles.ts

@@ -196,8 +196,8 @@ export function hasOpenActiveItemSlot(player: EntityPlayer): boolean {
 
   if (hasSchoolbag) {
     return (
-      activeItemPrimary === CollectibleType.NULL ||
-      activeItemSecondary === CollectibleType.NULL
+      activeItemPrimary === CollectibleType.NULL
+      || activeItemSecondary === CollectibleType.NULL
     );
   }
 
@@ -315,9 +315,7 @@ export function setActiveItem(
   const primaryCharge = player.GetActiveCharge(ActiveSlot.PRIMARY);
   const secondaryCollectibleType = player.GetActiveItem(ActiveSlot.SECONDARY);
 
-  if (charge === undefined) {
-    charge = getCollectibleMaxCharges(collectibleType);
-  }
+  charge ??= getCollectibleMaxCharges(collectibleType);
 
   if (!keepInPools) {
     itemPool.RemoveCollectible(collectibleType);

package/src/functions/playerDataStructures.ts

@@ -39,7 +39,7 @@ export function defaultMapGetPlayer<V, Args extends unknown[]>(
  * `mapSetPlayer` helper function.
  */
 export function defaultMapSetPlayer<V>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   map: Map<PlayerIndex, V>,
   player: EntityPlayer,
   value: V,
@@ -52,7 +52,7 @@ export function defaultMapSetPlayer<V>(
  * `Map.delete` method if you have a set of this type.
  */
 export function mapDeletePlayer(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   map: Map<PlayerIndex, unknown>,
   player: EntityPlayer,
 ): boolean {
@@ -121,7 +121,7 @@ export function mapHasPlayer<V>(
  * ```
  */
 export function mapSetPlayer<V>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   map: Map<PlayerIndex, V>,
   player: EntityPlayer,
   value: V,
@@ -135,7 +135,7 @@ export function mapSetPlayer<V>(
  * `Set.add` method if you have a set of this type.
  */
 export function setAddPlayer(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   set: Set<PlayerIndex>,
   player: EntityPlayer,
 ): void {
@@ -148,7 +148,7 @@ export function setAddPlayer(
  * `Set.delete` method if you have a set of this type.
  */
 export function setDeletePlayer(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   set: Set<PlayerIndex>,
   player: EntityPlayer,
 ): boolean {

package/src/functions/playerHealth.ts

@@ -381,8 +381,8 @@ export function getPlayerMaxHeartContainers(player: EntityPlayer): int {
   // 1
   // Magdalene can increase her maximum heart containers with Birthright.
   if (
-    character === PlayerType.MAGDALENE &&
-    player.HasCollectible(CollectibleType.BIRTHRIGHT)
+    character === PlayerType.MAGDALENE
+    && player.HasCollectible(CollectibleType.BIRTHRIGHT)
   ) {
     const extraMaxHeartContainersFromBirthright = 6;
     return characterMaxHeartContainers + extraMaxHeartContainersFromBirthright;
@@ -404,9 +404,9 @@ export function getPlayerMaxHeartContainers(player: EntityPlayer): int {
       : 0;
 
     return (
-      characterMaxHeartContainers +
-      numMothersKisses +
-      greedsGulletCoinContainers
+      characterMaxHeartContainers
+      + numMothersKisses
+      + greedsGulletCoinContainers
     );
   }
 
@@ -599,9 +599,9 @@ export function setPlayerHealth(
       playerHealth.soulHearts + playerHealth.boneHearts * 2 < (i + 1) * 2;
     let addAmount = 2;
     if (
-      isHalf ||
-      soulHeartType === HeartSubType.BONE ||
-      soulHeartsRemaining < 2
+      isHalf
+      || soulHeartType === HeartSubType.BONE
+      || soulHeartsRemaining < 2
     ) {
       // Fix the bug where a half soul heart to the left of a bone heart will be treated as a full
       // soul heart.

package/src/functions/playerIndex.ts

@@ -219,8 +219,8 @@ export function isChildPlayer(player: EntityPlayer): boolean {
  */
 export function isFoundSoul(player: EntityPlayer): boolean {
   return (
-    isChildPlayer(player) &&
-    player.Variant === PlayerVariant.COOP_BABY &&
-    player.SubType === (BabySubType.FOUND_SOUL as int)
+    isChildPlayer(player)
+    && player.Variant === PlayerVariant.COOP_BABY
+    && player.SubType === (BabySubType.FOUND_SOUL as int)
   );
 }

package/src/functions/players.ts

@@ -56,10 +56,10 @@ export function canPlayerCrushRocks(player: EntityPlayer): boolean {
   const effects = player.GetEffects();
 
   return (
-    player.HasCollectible(CollectibleType.LEO) ||
-    player.HasCollectible(CollectibleType.THUNDER_THIGHS) ||
-    effects.HasCollectibleEffect(CollectibleType.MEGA_MUSH) ||
-    player.HasPlayerForm(PlayerForm.STOMPY)
+    player.HasCollectible(CollectibleType.LEO)
+    || player.HasCollectible(CollectibleType.THUNDER_THIGHS)
+    || effects.HasCollectibleEffect(CollectibleType.MEGA_MUSH)
+    || player.HasPlayerForm(PlayerForm.STOMPY)
   );
 }
 

package/src/functions/pocketItems.ts

@@ -47,8 +47,8 @@ export function getFirstCardOrPill(
   const pocketItems = getPocketItems(player);
   return pocketItems.find(
     (pocketItem) =>
-      pocketItem.type === PocketItemType.CARD ||
-      pocketItem.type === PocketItemType.PILL,
+      pocketItem.type === PocketItemType.CARD
+      || pocketItem.type === PocketItemType.PILL,
   );
 }
 

package/src/functions/positionVelocity.ts

@@ -112,9 +112,7 @@ export function findFreePosition(
 export function getEntityPositions(
   entities?: readonly Entity[],
 ): ReadonlyMap<PtrHash, Vector> {
-  if (entities === undefined) {
-    entities = getEntities();
-  }
+  entities ??= getEntities();
 
   const entityPositions = new Map<PtrHash, Vector>();
   for (const entity of entities) {
@@ -137,9 +135,7 @@ export function getEntityPositions(
 export function getEntityVelocities(
   entities?: readonly Entity[],
 ): ReadonlyMap<PtrHash, Vector> {
-  if (entities === undefined) {
-    entities = getEntities();
-  }
+  entities ??= getEntities();
 
   const entityVelocities = new Map<PtrHash, Vector>();
   for (const entity of entities) {
@@ -167,9 +163,7 @@ export function setEntityPositions(
   entityPositions: ReadonlyMap<PtrHash, Vector>,
   entities?: readonly Entity[],
 ): void {
-  if (entities === undefined) {
-    entities = getEntities();
-  }
+  entities ??= getEntities();
 
   for (const entity of entities) {
     const ptrHash = GetPtrHash(entity);
@@ -197,9 +191,7 @@ export function setEntityVelocities(
   entityVelocities: ReadonlyMap<PtrHash, Vector>,
   entities?: readonly Entity[],
 ): void {
-  if (entities === undefined) {
-    entities = getEntities();
-  }
+  entities ??= getEntities();
 
   for (const entity of entities) {
     const ptrHash = GetPtrHash(entity);

package/src/functions/revive.ts

@@ -35,8 +35,8 @@ export function isDamageToPlayerFatal(
   // If we are Tainted Jacob and the damage source is Dark Esau, this will not be fatal damage
   // (because we will transform into Tainted Jacob's lost form).
   if (
-    character === PlayerType.JACOB_B &&
-    source.Type === EntityType.DARK_ESAU
+    character === PlayerType.JACOB_B
+    && source.Type === EntityType.DARK_ESAU
   ) {
     return false;
   }
@@ -50,11 +50,11 @@ export function isDamageToPlayerFatal(
   // If we are playing Tainted Samson and the incoming hit will cause us to become Berserk, then
   // this will not be fatal damage.
   const berserkChargeAfterHit =
-    player.SamsonBerserkCharge +
-    TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE;
+    player.SamsonBerserkCharge
+    + TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE;
   if (
-    character === PlayerType.SAMSON_B &&
-    berserkChargeAfterHit >= MAX_TAINTED_SAMSON_BERSERK_CHARGE
+    character === PlayerType.SAMSON_B
+    && berserkChargeAfterHit >= MAX_TAINTED_SAMSON_BERSERK_CHARGE
   ) {
     return false;
   }
@@ -89,8 +89,8 @@ export function isDamageToPlayerFatal(
   // This will not be fatal damage if we have Glass Cannon and this is the second time we are taking
   // damage on the same frame.
   if (
-    player.HasCollectible(CollectibleType.BROKEN_GLASS_CANNON) &&
-    onGameFrame(lastDamageGameFrame)
+    player.HasCollectible(CollectibleType.BROKEN_GLASS_CANNON)
+    && onGameFrame(lastDamageGameFrame)
   ) {
     return false;
   }
@@ -103,11 +103,11 @@ export function isDamageToPlayerFatal(
   const soulHearts = player.GetSoulHearts();
   const boneHearts = player.GetBoneHearts();
   if (
-    (hearts > 0 && soulHearts > 0) ||
-    (hearts > 0 && boneHearts > 0) ||
-    (soulHearts > 0 && boneHearts > 0) ||
-    (soulHearts > 0 && eternalHearts > 0) ||
-    boneHearts >= 2 // Two bone hearts and nothing else should not result in a death
+    (hearts > 0 && soulHearts > 0)
+    || (hearts > 0 && boneHearts > 0)
+    || (soulHearts > 0 && boneHearts > 0)
+    || (soulHearts > 0 && eternalHearts > 0)
+    || boneHearts >= 2 // Two bone hearts and nothing else should not result in a death
   ) {
     return false;
   }
@@ -155,8 +155,8 @@ export function willPlayerRevive(player: EntityPlayer): boolean {
   );
 
   const willRevive =
-    player.WillPlayerRevive() ||
-    (trinketSituation !== undefined && willMysteriousPaperRevive(player));
+    player.WillPlayerRevive()
+    || (trinketSituation !== undefined && willMysteriousPaperRevive(player));
 
   giveTrinketsBack(player, trinketSituation);
 

package/src/functions/rng.ts

@@ -17,7 +17,8 @@ export type SerializedRNG = LuaMap<string, unknown> & {
 /**
  * This is the ShiftIdx that Blade recommended after having reviewing the game's internal functions.
  * Any value between 0 and 80 should work equally well.
- * https://www.jstatsoft.org/article/view/v008i14/xorshift.pdf
+ *
+ * @see https://www.jstatsoft.org/article/view/v008i14/xorshift.pdf
  */
 const RECOMMENDED_SHIFT_IDX = 35;
 
@@ -63,7 +64,7 @@ export function deserializeRNG(rng: SerializedRNG): RNG {
  * the game.
  */
 export function getRandomSeed(): Seed {
-  const randomNumber = Random(); // eslint-disable-line deprecation/deprecation
+  const randomNumber = Random(); // eslint-disable-line @typescript-eslint/no-deprecated
   const safeRandomNumber = randomNumber === 0 ? 1 : randomNumber;
   return safeRandomNumber as Seed;
 }
@@ -171,6 +172,6 @@ export function setSeed(rng: RNG, seed: Seed): void {
   }
 
   // The game expects seeds in the range of 1 to 4294967295 (1^32 - 1).
-  // eslint-disable-next-line deprecation/deprecation
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   rng.SetSeed(seed, RECOMMENDED_SHIFT_IDX);
 }

package/src/functions/roomData.ts

@@ -65,9 +65,7 @@ export function getRoomData(roomGridIndex?: int): RoomConfig | undefined {
 export function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor {
   const level = game.GetLevel();
 
-  if (roomGridIndex === undefined) {
-    roomGridIndex = getRoomGridIndex();
-  }
+  roomGridIndex ??= getRoomGridIndex();
 
   return level.GetRoomByIdx(roomGridIndex);
 }

package/src/functions/roomGrid.ts

@@ -94,8 +94,8 @@ function isValidGridPositionLRoom(gridPosition: Vector, roomShape: RoomShape) {
     horizontalBottomRight,
   } = rectangles;
   return (
-    inRectangle(gridPosition, verticalTopLeft, verticalBottomRight) ||
-    inRectangle(gridPosition, horizontalTopLeft, horizontalBottomRight)
+    inRectangle(gridPosition, verticalTopLeft, verticalBottomRight)
+    || inRectangle(gridPosition, horizontalTopLeft, horizontalBottomRight)
   );
 }