isaacscript-common 87.5.0 → 87.6.0

package/src/functions/rooms.ts

@@ -106,8 +106,8 @@ export function getReadOnlyRooms(): ReadonlyArray<Readonly<RoomDescriptor>> {
   for (let i = 0; i < roomList.Size; i++) {
     const readOnlyRoomDescriptor = roomList.Get(i);
     if (
-      readOnlyRoomDescriptor !== undefined &&
-      readOnlyRoomDescriptor.Data !== undefined
+      readOnlyRoomDescriptor !== undefined
+      && readOnlyRoomDescriptor.Data !== undefined
     ) {
       readOnlyRoomDescriptors.push(readOnlyRoomDescriptor);
     }
@@ -216,8 +216,7 @@ export function getRooms(
  * Room descriptors without any data are assumed to be non-existent and are not included.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
- *                                 extra-dimensional rooms are automatically be generated. Default
- *                                 is false.
+ *                                 extra-dimensional rooms will be generated. Default is false.
  */
 export function getRoomsInsideGrid(
   includeExtraDimensionalRooms = false,
@@ -559,32 +558,32 @@ export function isAllRoomsClear(
     const roomTypeWhitelist = new ReadonlySet(onlyCheckRoomTypes);
     matchingRooms = roomsInsideGrid.filter(
       (roomDescriptor) =>
-        roomDescriptor.Data !== undefined &&
-        roomTypeWhitelist.has(roomDescriptor.Data.Type),
+        roomDescriptor.Data !== undefined
+        && roomTypeWhitelist.has(roomDescriptor.Data.Type),
     );
   }
 
   if (!includeSecretRoom) {
     matchingRooms = matchingRooms.filter(
       (roomDescriptor) =>
-        roomDescriptor.Data !== undefined &&
-        roomDescriptor.Data.Type !== RoomType.SECRET,
+        roomDescriptor.Data !== undefined
+        && roomDescriptor.Data.Type !== RoomType.SECRET,
     );
   }
 
   if (!includeSuperSecretRoom) {
     matchingRooms = matchingRooms.filter(
       (roomDescriptor) =>
-        roomDescriptor.Data !== undefined &&
-        roomDescriptor.Data.Type !== RoomType.SUPER_SECRET,
+        roomDescriptor.Data !== undefined
+        && roomDescriptor.Data.Type !== RoomType.SUPER_SECRET,
     );
   }
 
   if (!includeUltraSecretRoom) {
     matchingRooms = matchingRooms.filter(
       (roomDescriptor) =>
-        roomDescriptor.Data !== undefined &&
-        roomDescriptor.Data.Type !== RoomType.ULTRA_SECRET,
+        roomDescriptor.Data !== undefined
+        && roomDescriptor.Data.Type !== RoomType.ULTRA_SECRET,
     );
   }
 
@@ -599,8 +598,9 @@ export function isAllRoomsClear(
  */
 export function isAngelShop(roomData: RoomConfig): boolean {
   return (
-    roomData.Type === RoomType.ANGEL &&
-    roomData.Subtype === AngelRoomSubType.SHOP
+    roomData.Type === RoomType.ANGEL
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && roomData.Subtype === AngelRoomSubType.SHOP
   );
 }
 
@@ -614,8 +614,9 @@ export function isAngelShop(roomData: RoomConfig): boolean {
  */
 export function isBeastRoom(roomData: RoomConfig): boolean {
   return (
-    roomData.Type === RoomType.DUNGEON &&
-    roomData.Subtype === DungeonSubType.BEAST_ROOM
+    roomData.Type === RoomType.DUNGEON
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && roomData.Subtype === DungeonSubType.BEAST_ROOM
   );
 }
 
@@ -633,9 +634,10 @@ export function isBigRoom(roomData: RoomConfig): boolean {
  */
 export function isBossRoomOf(roomData: RoomConfig, bossID: BossID): boolean {
   return (
-    roomData.Type === RoomType.BOSS &&
-    roomData.StageID === StageID.SPECIAL_ROOMS &&
-    roomData.Subtype === bossID
+    roomData.Type === RoomType.BOSS
+    && roomData.StageID === StageID.SPECIAL_ROOMS
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && roomData.Subtype === bossID
   );
 }
 
@@ -646,8 +648,9 @@ export function isBossRoomOf(roomData: RoomConfig, bossID: BossID): boolean {
  */
 export function isCrawlSpace(roomData: RoomConfig): boolean {
   return (
-    roomData.Type === RoomType.DUNGEON &&
-    roomData.Subtype === DungeonSubType.NORMAL
+    roomData.Type === RoomType.DUNGEON
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && roomData.Subtype === DungeonSubType.NORMAL
   );
 }
 
@@ -668,9 +671,11 @@ export function isCrawlSpaceWithBlackMarketEntrance(
  */
 export function isDeathCertificateArea(roomData: RoomConfig): boolean {
   return (
-    roomData.StageID === StageID.HOME &&
-    (roomData.Subtype === HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE ||
-      roomData.Subtype === HomeRoomSubType.DEATH_CERTIFICATE_ITEMS)
+    roomData.StageID === StageID.HOME
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && (roomData.Subtype === HomeRoomSubType.DEATH_CERTIFICATE_ENTRANCE
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+      || roomData.Subtype === HomeRoomSubType.DEATH_CERTIFICATE_ITEMS)
   );
 }
 
@@ -701,10 +706,11 @@ export function isDevilsCrownTreasureRoom(
  */
 export function isDogmaRoom(roomData: RoomConfig): boolean {
   return (
-    roomData.StageID === StageID.HOME &&
-    roomData.Type === RoomType.DEFAULT &&
-    roomData.Variant === 1000 &&
-    roomData.Subtype === HomeRoomSubType.LIVING_ROOM
+    roomData.StageID === StageID.HOME
+    && roomData.Type === RoomType.DEFAULT
+    && roomData.Variant === 1000
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && roomData.Subtype === HomeRoomSubType.LIVING_ROOM
   );
 }
 
@@ -729,6 +735,7 @@ export function isDoubleTrouble(roomData: RoomConfig): boolean {
  * Helper function to determine if the index of the provided room is equal to `GridRoom.GENESIS`.
  */
 export function isGenesisRoom(roomGridIndex: int): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return roomGridIndex === GridRoom.GENESIS;
 }
 
@@ -740,9 +747,11 @@ export function isGenesisRoom(roomGridIndex: int): boolean {
  */
 export function isHomeCloset(roomData: RoomConfig): boolean {
   return (
-    roomData.StageID === StageID.HOME &&
-    (roomData.Subtype === HomeRoomSubType.CLOSET_LEFT ||
-      roomData.Subtype === HomeRoomSubType.CLOSET_RIGHT)
+    roomData.StageID === StageID.HOME
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && (roomData.Subtype === HomeRoomSubType.CLOSET_LEFT
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+      || roomData.Subtype === HomeRoomSubType.CLOSET_RIGHT)
   );
 }
 
@@ -755,6 +764,7 @@ export function isLRoom(roomData: RoomConfig): boolean {
  * Helper function to determine if the index of the provided room is equal to `GridRoom.MEGA_SATAN`.
  */
 export function isMegaSatanRoom(roomGridIndex: int): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return roomGridIndex === GridRoom.MEGA_SATAN;
 }
 
@@ -764,10 +774,9 @@ export function isMegaSatanRoom(roomGridIndex: int): boolean {
  */
 export function isMineShaft(roomData: RoomConfig): boolean {
   return (
-    (roomData.StageID === StageID.MINES ||
-      roomData.StageID === StageID.ASHPIT) &&
-    // eslint-disable-next-line isaacscript/strict-enums
-    MINE_SHAFT_ROOM_SUB_TYPE_SET.has(roomData.Subtype)
+    (roomData.StageID === StageID.MINES || roomData.StageID === StageID.ASHPIT)
+    // eslint-disable-next-line complete/strict-enums
+    && MINE_SHAFT_ROOM_SUB_TYPE_SET.has(roomData.Subtype)
   );
 }
 
@@ -780,9 +789,10 @@ export function isMinibossRoomOf(
   minibossID: MinibossID,
 ): boolean {
   return (
-    roomData.Type === RoomType.MINI_BOSS &&
-    roomData.StageID === StageID.SPECIAL_ROOMS &&
-    roomData.Subtype === minibossID
+    roomData.Type === RoomType.MINI_BOSS
+    && roomData.StageID === StageID.SPECIAL_ROOMS
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && roomData.Subtype === minibossID
   );
 }
 
@@ -792,10 +802,11 @@ export function isMinibossRoomOf(
  */
 export function isMirrorRoom(roomData: RoomConfig): boolean {
   return (
-    roomData.Type === RoomType.DEFAULT &&
-    (roomData.StageID === StageID.DOWNPOUR ||
-      roomData.StageID === StageID.DROSS) &&
-    roomData.Subtype === DownpourRoomSubType.MIRROR
+    roomData.Type === RoomType.DEFAULT
+    && (roomData.StageID === StageID.DOWNPOUR
+      || roomData.StageID === StageID.DROSS)
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
+    && roomData.Subtype === DownpourRoomSubType.MIRROR
   );
 }
 
@@ -828,6 +839,7 @@ export function isRoomType(
  * floor.
  */
 export function isSecretExit(roomGridIndex: int): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return roomGridIndex === GridRoom.SECRET_EXIT;
 }
 
@@ -848,6 +860,7 @@ export function isSecretRoomType(roomType: RoomType): boolean {
  * the only way to detect them is by using the grid index.
  */
 export function isSecretShop(roomGridIndex: int): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return roomGridIndex === GridRoom.SECRET_SHOP;
 }
 

package/src/functions/set.ts

@@ -10,7 +10,7 @@ import { isPrimitive } from "./types";
  * This function is variadic, meaning that you can specify N sets to add to the first set.
  */
 export function addSetsToSet<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   mainSet: Set<T>,
   ...setsToAdd: ReadonlyArray<ReadonlySet<T>>
 ): void {
@@ -26,7 +26,7 @@ export function addSetsToSet<T>(
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T> {
   const newSet = new Set<T>();
   for (const set of sets) {
@@ -39,7 +39,7 @@ export function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T> {
 }
 
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
   const newSet = new Set<T>();
   for (const value of oldSet) {
@@ -56,7 +56,7 @@ export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
  * This function is variadic, meaning that you can specify N sets to remove from the first set.
  */
 export function deleteSetsFromSet<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   mainSet: Set<T>,
   ...setsToRemove: ReadonlyArray<ReadonlySet<T>>
 ): void {
@@ -123,7 +123,7 @@ export function getSetCombinations<T extends number | string>(
  * Normally, set values are returned in insertion order, so use this function when the ordering of
  * the contents is important.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function getSortedSetValues<T extends number | string>(
   set: ReadonlySet<T>,
 ): T[] {
@@ -167,7 +167,7 @@ export function objectKeysToReadonlySet<K extends string | number | symbol, V>(
  *
  * Also see the `objectKeysToReadonlySet` function.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function objectKeysToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
 ): Set<K> {
@@ -203,7 +203,7 @@ export function objectValuesToReadonlySet<
  *
  * Also see the `objectValuesToReadonlySet` function.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function objectValuesToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
 ): Set<V> {
@@ -222,7 +222,7 @@ export function objectValuesToSet<K extends string | number | symbol, V>(
  *
  * This function is variadic, meaning that you can pass as many things as you want to add.
  */
-// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+// eslint-disable-next-line complete/prefer-readonly-parameter-types
 export function setAdd<T>(set: Set<T>, ...elements: readonly T[]): void {
   for (const element of elements) {
     set.add(element);

package/src/functions/sort.ts

@@ -149,9 +149,9 @@ export function sortTwoDimensionalArray<T>(
  *
  * Under the hood, this uses the merge sort algorithm.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function stableSort<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   sortFunc: (a: T, b: T) => -1 | 0 | 1 = sortNormal,
 ): T[] {
@@ -174,8 +174,8 @@ export function stableSort<T>(
   let leftIndex = 0;
   let rightIndex = 0;
   while (
-    leftIndex < sortedLeftArray.length &&
-    rightIndex < sortedRightArray.length
+    leftIndex < sortedLeftArray.length
+    && rightIndex < sortedRightArray.length
   ) {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const left = sortedLeftArray[leftIndex]!;

package/src/functions/sound.ts

@@ -24,13 +24,8 @@ export function getMusicForStage(
 ): Music {
   const level = game.GetLevel();
 
-  if (stage === undefined) {
-    stage = level.GetStage();
-  }
-
-  if (stageType === undefined) {
-    stageType = level.GetStageType();
-  }
+  stage ??= level.GetStage();
+  stageType ??= level.GetStageType();
 
   const stageTypeToMusic = STAGE_TO_MUSIC[stage];
   return stageTypeToMusic[stageType];

package/src/functions/spawnCollectible.ts

@@ -44,9 +44,7 @@ export function spawnCollectible(
   forceFreeItem = false,
   spawner?: Entity,
 ): EntityPickupCollectible {
-  if (seedOrRNG === undefined) {
-    seedOrRNG = getRandomSeed();
-  }
+  seedOrRNG ??= getRandomSeed();
 
   const seed = isRNG(seedOrRNG) ? seedOrRNG.Next() : seedOrRNG;
   const collectible = spawnPickupWithSeed(
@@ -67,9 +65,9 @@ export function spawnCollectible(
   }
 
   if (
-    anyPlayerIs(PlayerType.KEEPER_B) &&
-    !isQuestCollectible(collectibleType) &&
-    !forceFreeItem
+    anyPlayerIs(PlayerType.KEEPER_B)
+    && !isQuestCollectible(collectibleType)
+    && !forceFreeItem
   ) {
     // When playing Tainted Keeper, collectibles are supposed to have a price, and manually spawned
     // items will not have a price, so we have to set it manually.

package/src/functions/stage.ts

@@ -133,13 +133,8 @@ export function getLevelName(
 ): string {
   const level = game.GetLevel();
 
-  if (stage === undefined) {
-    stage = level.GetStage();
-  }
-
-  if (stageType === undefined) {
-    stageType = level.GetStageType();
-  }
+  stage ??= level.GetStage();
+  stageType ??= level.GetStageType();
 
   const stageID = getStageID(stage, stageType);
   const stageIDName = getStageIDName(stageID);
@@ -195,13 +190,8 @@ export function getStage(): LevelStage {
 export function getStageID(stage?: LevelStage, stageType?: StageType): StageID {
   const level = game.GetLevel();
 
-  if (stage === undefined) {
-    stage = level.GetStage();
-  }
-
-  if (stageType === undefined) {
-    stageType = level.GetStageType();
-  }
+  stage ??= level.GetStage();
+  stageType ??= level.GetStageType();
 
   if (game.IsGreedMode()) {
     const stageTypeToStageID = STAGE_TO_STAGE_ID_GREED_MODE.get(stage);
@@ -255,10 +245,10 @@ export function getStageTypeSuffix(stageType: StageType): string {
  */
 export function isFinalFloor(stage: LevelStage, stageType: StageType): boolean {
   return (
-    stage === LevelStage.DARK_ROOM_CHEST ||
-    stage === LevelStage.VOID ||
-    stage === LevelStage.HOME ||
-    (stage === LevelStage.WOMB_2 && isRepentanceStage(stageType)) // Corpse 2
+    stage === LevelStage.DARK_ROOM_CHEST
+    || stage === LevelStage.VOID
+    || stage === LevelStage.HOME
+    || (stage === LevelStage.WOMB_2 && isRepentanceStage(stageType)) // Corpse 2
   );
 }
 
@@ -284,8 +274,8 @@ export function isStageWithNaturalDevilRoom(
   effectiveStage: LevelStage,
 ): boolean {
   return (
-    inRange(effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2) &&
-    effectiveStage !== LevelStage.BLUE_WOMB
+    inRange(effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2)
+    && effectiveStage !== LevelStage.BLUE_WOMB
   );
 }
 
@@ -323,8 +313,8 @@ export function isStageWithSecretExitToMausoleum(
   const repentanceStage = isRepentanceStage(stageType);
 
   return (
-    (stage === LevelStage.DEPTHS_1 && !repentanceStage) ||
-    (stage === LevelStage.CAVES_2 && repentanceStage)
+    (stage === LevelStage.DEPTHS_1 && !repentanceStage)
+    || (stage === LevelStage.CAVES_2 && repentanceStage)
   );
 }
 
@@ -339,8 +329,8 @@ export function isStageWithSecretExitToMines(
   const repentanceStage = isRepentanceStage(stageType);
 
   return (
-    (stage === LevelStage.CAVES_1 && !repentanceStage) ||
-    (stage === LevelStage.BASEMENT_2 && repentanceStage)
+    (stage === LevelStage.CAVES_1 && !repentanceStage)
+    || (stage === LevelStage.BASEMENT_2 && repentanceStage)
   );
 }
 
@@ -355,8 +345,8 @@ export function isStageWithShovelTrapdoors(
   const repentanceStage = isRepentanceStage(stageType);
 
   return (
-    stage < LevelStage.WOMB_2 ||
-    (stage === LevelStage.WOMB_2 && !repentanceStage)
+    stage < LevelStage.WOMB_2
+    || (stage === LevelStage.WOMB_2 && !repentanceStage)
   );
 }
 
@@ -384,8 +374,8 @@ export function onCathedral(): boolean {
   const stageType = level.GetStageType();
 
   return (
-    stage === LevelStage.SHEOL_CATHEDRAL &&
-    stageType === StageType.WRATH_OF_THE_LAMB
+    stage === LevelStage.SHEOL_CATHEDRAL
+    && stageType === StageType.WRATH_OF_THE_LAMB
   );
 }
 
@@ -395,8 +385,8 @@ export function onChest(): boolean {
   const stageType = level.GetStageType();
 
   return (
-    stage === LevelStage.DARK_ROOM_CHEST &&
-    stageType === StageType.WRATH_OF_THE_LAMB
+    stage === LevelStage.DARK_ROOM_CHEST
+    && stageType === StageType.WRATH_OF_THE_LAMB
   );
 }
 

package/src/functions/string.ts

@@ -153,9 +153,9 @@ export function parseSemanticVersion(versionString: string):
     string.match(versionString, "(%d+).(%d+).(%d+)");
 
   if (
-    majorVersionString === undefined ||
-    minorVersionString === undefined ||
-    patchVersionString === undefined
+    majorVersionString === undefined
+    || minorVersionString === undefined
+    || patchVersionString === undefined
   ) {
     return undefined;
   }
@@ -165,9 +165,9 @@ export function parseSemanticVersion(versionString: string):
   const patchVersion = parseIntSafe(patchVersionString);
 
   if (
-    majorVersion === undefined ||
-    minorVersion === undefined ||
-    patchVersion === undefined
+    majorVersion === undefined
+    || minorVersion === undefined
+    || patchVersion === undefined
   ) {
     return undefined;
   }

package/src/functions/tears.ts

@@ -103,8 +103,8 @@ export function isTearFromFamiliar(
   }
 
   return (
-    (familiarVariant === undefined || familiarVariant === familiar.Variant) &&
-    (subType === undefined || subType === familiar.SubType)
+    (familiarVariant === undefined || familiarVariant === familiar.Variant)
+    && (subType === undefined || subType === familiar.SubType)
   );
 }
 

package/src/functions/trinketGive.ts

@@ -124,14 +124,14 @@ export function temporarilyRemoveTrinket(
 
   let numSmeltedTrinkets = numTrinkets;
   const trinketWasInSlot1 =
-    trinketType1 === trinketType ||
-    trinketType1 === getGoldenTrinketType(trinketType);
+    trinketType1 === trinketType
+    || trinketType1 === getGoldenTrinketType(trinketType);
   if (trinketWasInSlot1) {
     numSmeltedTrinkets--;
   }
   const trinketWasInSlot2 =
-    trinketType2 === trinketType ||
-    trinketType2 === getGoldenTrinketType(trinketType);
+    trinketType2 === trinketType
+    || trinketType2 === getGoldenTrinketType(trinketType);
   if (trinketWasInSlot2) {
     numSmeltedTrinkets--;
   }

package/src/functions/trinkets.ts

@@ -69,9 +69,7 @@ export function getMysteriousPaperEffectForFrame(
   player: EntityPlayer,
   frameCount?: int,
 ): MysteriousPaperEffect | undefined {
-  if (frameCount === undefined) {
-    frameCount = player.FrameCount;
-  }
+  frameCount ??= player.FrameCount;
 
   if (!player.HasTrinket(TrinketType.MYSTERIOUS_PAPER)) {
     return undefined;

package/src/functions/tstlClass.ts

@@ -45,10 +45,10 @@ export function getTSTLClassName(object: unknown): string | undefined {
 }
 
 /**
- * Helper function to determine if a given object is a TypeScriptToLua `Map`.
+ * Helper function to determine if a given object is a `DefaultMap` from `isaacscript-common`.
  *
  * It is not reliable to use the `instanceof` operator to determine this because each Lua module has
- * their own copies of the entire lualib and thus their own instantiated version of a `Map`.
+ * their own copies of the entire lualib and thus their own instantiated version of a `DefaultMap`.
  */
 export function isDefaultMap(
   object: unknown,