isaacscript-common 20.3.0 → 20.3.2

package/src/functions/utils.ts

@@ -9,15 +9,14 @@ import { CONSOLE_COMMANDS_SET } from "../sets/consoleCommandsSet";
  * - For example, `eRange(1, 3)` will return `[1, 2]`.
  * - For example, `eRange(2)` will return `[0, 1]`.
  *
- * @param start The number to start at.
- * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
 export function eRange(start: int, end?: int, increment = 1): int[] {
   if (end === undefined) {
-    end = start;
-    start = 0;
+    return eRange(0, start);
   }
 
   const array: int[] = [];
@@ -52,23 +51,18 @@ export function getTraversalDescription(
  * - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
  * - For example, `iRange(2)` will return `[0, 1, 2]`.
  *
- * @param start The number to start at.
- * @param end Optional. The number to end at. If not specified, then the start will be 0 and the
+ * @param start The integer to start at.
+ * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
  *            first argument will be the end.
  * @param increment Optional. The increment to use. Default is 1.
  */
 export function iRange(start: int, end?: int, increment = 1): int[] {
   if (end === undefined) {
-    end = start;
-    start = 0;
+    return iRange(0, start);
   }
 
-  const array: int[] = [];
-  for (let i = start; i <= end; i += increment) {
-    array.push(i);
-  }
-
-  return array;
+  const exclusiveEnd = end + 1;
+  return eRange(start, exclusiveEnd, increment);
 }
 
 /**
@@ -226,7 +220,7 @@ export function twoDimensionalSort<T>(array1: T[], array2: T[]): -1 | 0 | 1 {
  *
  * This function is only meant to be used with interfaces (i.e. types that will not exist at
  * run-time). If you are generating an object that will contain all of the keys of an enum, use the
- * `newObjectWithEnumKeys` helper function instead.
+ * `satisfies` operator with the `HasAllEnumValues` helper type instead.
  */
 export function validateInterfaceMatchesEnum<
   // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/src/functions/vector.ts

@@ -20,7 +20,7 @@ export type SerializedVector = LuaMap<string, unknown> & {
 };
 
 const OBJECT_NAME = "Vector";
-const KEYS = ["X", "Y"];
+const KEYS = ["X", "Y"] as const;
 
 /** Helper function to copy a `Vector` Isaac API class. */
 export function copyVector(vector: Vector): Vector {

package/src/maps/characterNameToTypeMap.ts

@@ -1,88 +1,89 @@
 import { PlayerType } from "isaac-typescript-definitions";
 
 /** Maps character names to the values of the `PlayerType` enum. */
-export const CHARACTER_NAME_TO_TYPE_MAP = new Map<string, PlayerType>([
-  ["isaac", PlayerType.ISAAC], // 0
-  ["magdalene", PlayerType.MAGDALENE], // 1
-  ["maggy", PlayerType.MAGDALENE], // 1
-  ["cain", PlayerType.CAIN], // 2
-  ["judas", PlayerType.JUDAS], // 3
-  ["blueBaby", PlayerType.BLUE_BABY], // 4
-  ["bb", PlayerType.BLUE_BABY], // 4
-  ["eve", PlayerType.EVE], // 5
-  ["samson", PlayerType.SAMSON], // 6
-  ["azazel", PlayerType.AZAZEL], // 7
-  ["lazarus", PlayerType.LAZARUS], // 8
-  // Needed so that "laz2" does not take precedence over "lazarus".
-  ["laz", PlayerType.LAZARUS], // 8
-  ["eden", PlayerType.EDEN], // 9
-  ["theLost", PlayerType.LOST], // 10
-  ["lost", PlayerType.LOST], // 10
-  ["lazarus2", PlayerType.LAZARUS_2], // 11
-  ["laz2", PlayerType.LAZARUS_2], // 11
-  ["darkJudas", PlayerType.DARK_JUDAS], // 12
-  ["dJudas", PlayerType.DARK_JUDAS], // 12
-  ["blackJudas", PlayerType.DARK_JUDAS], // 12
-  ["bJudas", PlayerType.DARK_JUDAS], // 12
-  ["lilith", PlayerType.LILITH], // 13
-  ["keeper", PlayerType.KEEPER], // 14
-  ["apollyon", PlayerType.APOLLYON], // 15
-  ["theForgotten", PlayerType.FORGOTTEN], // 16
-  ["forgotten", PlayerType.FORGOTTEN], // 16
-  ["theSoul", PlayerType.SOUL], // 17
-  ["soul", PlayerType.SOUL], // 17
-  ["bethany", PlayerType.BETHANY], // 18
-  ["jacob", PlayerType.JACOB], // 19
-  ["esau", PlayerType.ESAU], // 20
-  ["taintedIsaac", PlayerType.ISAAC_B], // 21
-  ["tIsaac", PlayerType.ISAAC_B], // 21
-  ["taintedMagdalene", PlayerType.MAGDALENE_B], // 22
-  ["tMagdalene", PlayerType.MAGDALENE_B], // 22
-  ["taintedMaggy", PlayerType.MAGDALENE_B], // 22
-  ["tMaggy", PlayerType.MAGDALENE_B], // 22
-  ["taintedCain", PlayerType.CAIN_B], // 23
-  ["tCain", PlayerType.CAIN_B], // 23
-  ["taintedJudas", PlayerType.JUDAS_B], // 24
-  ["tJudas", PlayerType.JUDAS_B], // 24
-  ["taintedBlueBaby", PlayerType.BLUE_BABY_B], // 25
-  ["tBlueBaby", PlayerType.BLUE_BABY_B], // 25
-  ["tbb", PlayerType.BLUE_BABY_B], // 25
-  ["taintedEve", PlayerType.EVE_B], // 26
-  ["tEve", PlayerType.EVE_B], // 26
-  ["taintedSamson", PlayerType.SAMSON_B], // 27
-  ["tSamson", PlayerType.SAMSON_B], // 27
-  ["taintedAzazel", PlayerType.AZAZEL_B], // 28
-  ["tAzazel", PlayerType.AZAZEL_B], // 28
-  ["taintedLazarus", PlayerType.LAZARUS_B], // 29
-  ["tLazarus", PlayerType.LAZARUS_B], // 29
-  ["taintedLaz", PlayerType.LAZARUS_B], // 29
-  ["tLaz", PlayerType.LAZARUS_B], // 29
-  ["taintedEden", PlayerType.EDEN_B], // 30
-  ["tEden", PlayerType.EDEN_B], // 30
-  ["taintedLost", PlayerType.LOST_B], // 31
-  ["tLost", PlayerType.LOST_B], // 31
-  ["taintedLilith", PlayerType.LILITH_B], // 32
-  ["tLilith", PlayerType.LILITH_B], // 32
-  ["taintedKeeper", PlayerType.KEEPER_B], // 33
-  ["tKeeper", PlayerType.KEEPER_B], // 33
-  ["taintedApollyon", PlayerType.APOLLYON_B], // 34
-  ["tApollyon", PlayerType.APOLLYON_B], // 34
-  ["taintedForgotten", PlayerType.FORGOTTEN_B], // 35
-  ["tForgotten", PlayerType.FORGOTTEN_B], // 35
-  ["taintedBethany", PlayerType.BETHANY_B], // 36
-  ["tBethany", PlayerType.BETHANY_B], // 36
-  ["taintedJacob", PlayerType.JACOB_B], // 37
-  ["tJacob", PlayerType.JACOB_B], // 37
-  ["taintedLazarusDead", PlayerType.LAZARUS_2_B], // 38
-  ["tLazarusDead", PlayerType.LAZARUS_2_B], // 38
-  ["taintedLazDead", PlayerType.LAZARUS_2_B], // 38
-  ["tLazDead", PlayerType.LAZARUS_2_B], // 38
-  ["deadTaintedLazarus", PlayerType.LAZARUS_2_B], // 38
-  ["deadTLazarus", PlayerType.LAZARUS_2_B], // 38
-  ["deadTaintedLaz", PlayerType.LAZARUS_2_B], // 38
-  ["deadTLaz", PlayerType.LAZARUS_2_B], // 38
-  ["taintedJacobGhost", PlayerType.JACOB_2_B], // 39
-  ["tJacobGhost", PlayerType.JACOB_2_B], // 39
-  ["taintedSoul", PlayerType.SOUL_B], // 40
-  ["tSoul", PlayerType.SOUL_B], // 40
-]);
+export const CHARACTER_NAME_TO_TYPE_MAP: ReadonlyMap<string, PlayerType> =
+  new Map([
+    ["isaac", PlayerType.ISAAC], // 0
+    ["magdalene", PlayerType.MAGDALENE], // 1
+    ["maggy", PlayerType.MAGDALENE], // 1
+    ["cain", PlayerType.CAIN], // 2
+    ["judas", PlayerType.JUDAS], // 3
+    ["blueBaby", PlayerType.BLUE_BABY], // 4
+    ["bb", PlayerType.BLUE_BABY], // 4
+    ["eve", PlayerType.EVE], // 5
+    ["samson", PlayerType.SAMSON], // 6
+    ["azazel", PlayerType.AZAZEL], // 7
+    ["lazarus", PlayerType.LAZARUS], // 8
+    // Needed so that "laz2" does not take precedence over "lazarus".
+    ["laz", PlayerType.LAZARUS], // 8
+    ["eden", PlayerType.EDEN], // 9
+    ["theLost", PlayerType.LOST], // 10
+    ["lost", PlayerType.LOST], // 10
+    ["lazarus2", PlayerType.LAZARUS_2], // 11
+    ["laz2", PlayerType.LAZARUS_2], // 11
+    ["darkJudas", PlayerType.DARK_JUDAS], // 12
+    ["dJudas", PlayerType.DARK_JUDAS], // 12
+    ["blackJudas", PlayerType.DARK_JUDAS], // 12
+    ["bJudas", PlayerType.DARK_JUDAS], // 12
+    ["lilith", PlayerType.LILITH], // 13
+    ["keeper", PlayerType.KEEPER], // 14
+    ["apollyon", PlayerType.APOLLYON], // 15
+    ["theForgotten", PlayerType.FORGOTTEN], // 16
+    ["forgotten", PlayerType.FORGOTTEN], // 16
+    ["theSoul", PlayerType.SOUL], // 17
+    ["soul", PlayerType.SOUL], // 17
+    ["bethany", PlayerType.BETHANY], // 18
+    ["jacob", PlayerType.JACOB], // 19
+    ["esau", PlayerType.ESAU], // 20
+    ["taintedIsaac", PlayerType.ISAAC_B], // 21
+    ["tIsaac", PlayerType.ISAAC_B], // 21
+    ["taintedMagdalene", PlayerType.MAGDALENE_B], // 22
+    ["tMagdalene", PlayerType.MAGDALENE_B], // 22
+    ["taintedMaggy", PlayerType.MAGDALENE_B], // 22
+    ["tMaggy", PlayerType.MAGDALENE_B], // 22
+    ["taintedCain", PlayerType.CAIN_B], // 23
+    ["tCain", PlayerType.CAIN_B], // 23
+    ["taintedJudas", PlayerType.JUDAS_B], // 24
+    ["tJudas", PlayerType.JUDAS_B], // 24
+    ["taintedBlueBaby", PlayerType.BLUE_BABY_B], // 25
+    ["tBlueBaby", PlayerType.BLUE_BABY_B], // 25
+    ["tbb", PlayerType.BLUE_BABY_B], // 25
+    ["taintedEve", PlayerType.EVE_B], // 26
+    ["tEve", PlayerType.EVE_B], // 26
+    ["taintedSamson", PlayerType.SAMSON_B], // 27
+    ["tSamson", PlayerType.SAMSON_B], // 27
+    ["taintedAzazel", PlayerType.AZAZEL_B], // 28
+    ["tAzazel", PlayerType.AZAZEL_B], // 28
+    ["taintedLazarus", PlayerType.LAZARUS_B], // 29
+    ["tLazarus", PlayerType.LAZARUS_B], // 29
+    ["taintedLaz", PlayerType.LAZARUS_B], // 29
+    ["tLaz", PlayerType.LAZARUS_B], // 29
+    ["taintedEden", PlayerType.EDEN_B], // 30
+    ["tEden", PlayerType.EDEN_B], // 30
+    ["taintedLost", PlayerType.LOST_B], // 31
+    ["tLost", PlayerType.LOST_B], // 31
+    ["taintedLilith", PlayerType.LILITH_B], // 32
+    ["tLilith", PlayerType.LILITH_B], // 32
+    ["taintedKeeper", PlayerType.KEEPER_B], // 33
+    ["tKeeper", PlayerType.KEEPER_B], // 33
+    ["taintedApollyon", PlayerType.APOLLYON_B], // 34
+    ["tApollyon", PlayerType.APOLLYON_B], // 34
+    ["taintedForgotten", PlayerType.FORGOTTEN_B], // 35
+    ["tForgotten", PlayerType.FORGOTTEN_B], // 35
+    ["taintedBethany", PlayerType.BETHANY_B], // 36
+    ["tBethany", PlayerType.BETHANY_B], // 36
+    ["taintedJacob", PlayerType.JACOB_B], // 37
+    ["tJacob", PlayerType.JACOB_B], // 37
+    ["taintedLazarusDead", PlayerType.LAZARUS_2_B], // 38
+    ["tLazarusDead", PlayerType.LAZARUS_2_B], // 38
+    ["taintedLazDead", PlayerType.LAZARUS_2_B], // 38
+    ["tLazDead", PlayerType.LAZARUS_2_B], // 38
+    ["deadTaintedLazarus", PlayerType.LAZARUS_2_B], // 38
+    ["deadTLazarus", PlayerType.LAZARUS_2_B], // 38
+    ["deadTaintedLaz", PlayerType.LAZARUS_2_B], // 38
+    ["deadTLaz", PlayerType.LAZARUS_2_B], // 38
+    ["taintedJacobGhost", PlayerType.JACOB_2_B], // 39
+    ["tJacobGhost", PlayerType.JACOB_2_B], // 39
+    ["taintedSoul", PlayerType.SOUL_B], // 40
+    ["tSoul", PlayerType.SOUL_B], // 40
+  ]);

package/src/objects/roomShapeBounds.ts

@@ -6,10 +6,10 @@ import {
   ONE_BY_ONE_CONTENTS_WIDTH,
 } from "./roomShapeVolumes";
 
-const TWO_BY_TWO_BOUNDS: [width: int, height: int] = [
+const TWO_BY_TWO_BOUNDS: readonly [width: int, height: int] = [
   ONE_BY_ONE_CONTENTS_WIDTH * 2,
   ONE_BY_ONE_CONTENTS_HEIGHT * 2,
-];
+] as const;
 
 /**
  * The size of a room shape's contents. This does not include the tiles that the walls are on. L

package/src/objects/roomShapeLayoutSizes.ts

@@ -7,19 +7,19 @@ import {
 const ONE_BY_ONE_LAYOUT_SIZE: readonly [width: int, height: int] = [
   ONE_BY_ONE_CONTENTS_WIDTH,
   ONE_BY_ONE_CONTENTS_HEIGHT,
-];
+] as const;
 const TWO_BY_ONE_VERTICAL_LAYOUT_SIZE: readonly [width: int, height: int] = [
   ONE_BY_ONE_CONTENTS_WIDTH,
   ONE_BY_ONE_CONTENTS_HEIGHT * 2,
-];
+] as const;
 const TWO_BY_ONE_HORIZONTAL_LAYOUT_SIZE: readonly [width: int, height: int] = [
   ONE_BY_ONE_CONTENTS_WIDTH * 2,
   ONE_BY_ONE_CONTENTS_HEIGHT,
-];
+] as const;
 const TWO_BY_TWO_LAYOUT_SIZE: readonly [width: int, height: int] = [
   ONE_BY_ONE_CONTENTS_WIDTH * 2,
   ONE_BY_ONE_CONTENTS_HEIGHT * 2,
-];
+] as const;
 
 /**
  * The dimensions of a room shape's layout. This is NOT the size of the room's actual contents! For

package/src/objects/roomShapeToDoorSlotCoordinates.ts

@@ -8,7 +8,7 @@ import { DoorSlot, RoomShape } from "isaac-typescript-definitions";
 // We need the maps to be read-only, so we specify the type instead of using the `satisfies`
 // operator.
 export const ROOM_SHAPE_TO_DOOR_SLOT_COORDINATES: {
-  readonly [Key in RoomShape]: ReadonlyMap<DoorSlot, [x: int, y: int]>;
+  readonly [Key in RoomShape]: ReadonlyMap<DoorSlot, readonly [x: int, y: int]>;
 } = {
   // 1
   [RoomShape.SHAPE_1x1]: new Map([

package/src/patchErrorFunctions.ts

@@ -11,14 +11,14 @@ const LINE_SEPARATOR = "\n";
  * These must be listed in order from how they appear in the traceback from top to bottom, or they
  * won't be properly removed.
  */
-const USELESS_TRACEBACK_MESSAGES: readonly string[] = [
+const USELESS_TRACEBACK_MESSAGES = [
   // The second line of the traceback will always be the "getTraceback" function.
   "in upvalue 'getTraceback'",
   "in function 'sandbox.GetTraceback'",
 
   // The third line of the traceback will always be a line within the "errorWithTraceback" function.
   "in function 'error'",
-];
+] as const;
 
 let vanillaError: ErrorFunction | undefined;
 

package/src/sets/bossSets.ts

@@ -3,7 +3,7 @@ import {
   ChubVariant,
   DaddyLongLegsVariant,
   DingleVariant,
-  DukeVariant,
+  DukeOfFliesVariant,
   EntityType,
   FallenVariant,
   FistulaVariant,
@@ -44,7 +44,7 @@ const BASEMENT_BOSSES_SET: ReadonlySet<string> = new Set([
   `${EntityType.LARRY_JR}.${LarryJrVariant.LARRY_JR}`, // 19.0
   `${EntityType.MONSTRO}.0`, // 20.0
   `${EntityType.FAMINE}.0`, // 63.0
-  `${EntityType.DUKE}.${DukeVariant.DUKE_OF_FLIES}`, // 67.0
+  `${EntityType.DUKE_OF_FLIES}.${DukeOfFliesVariant.DUKE_OF_FLIES}`, // 67.0
   `${EntityType.GEMINI}.${GeminiVariant.GEMINI}`, // 79.0
   `${EntityType.GEMINI}.${GeminiVariant.STEVEN}`, // 79.1
   `${EntityType.FALLEN}.${FallenVariant.FALLEN}`, // 81.0
@@ -61,7 +61,7 @@ const BASEMENT_BOSSES_SET: ReadonlySet<string> = new Set([
 const CELLAR_BOSSES_SET: ReadonlySet<string> = new Set([
   `${EntityType.PIN}.${PinVariant.PIN}`, // 62.0
   `${EntityType.FAMINE}.0`, // 63.0
-  `${EntityType.DUKE}.${DukeVariant.DUKE_OF_FLIES}`, // 67.0
+  `${EntityType.DUKE_OF_FLIES}.${DukeOfFliesVariant.DUKE_OF_FLIES}`, // 67.0
   `${EntityType.GEMINI}.${GeminiVariant.BLIGHTED_OVUM}`, // 79.2
   `${EntityType.FALLEN}.${FallenVariant.FALLEN}`, // 81.0
   `${EntityType.HEADLESS_HORSEMAN}.0`, // 82.0
@@ -77,7 +77,7 @@ const BURNING_BASEMENT_BOSSES_SET: ReadonlySet<string> = new Set([
   `${EntityType.LARRY_JR}.${LarryJrVariant.LARRY_JR}`, // 19.0
   `${EntityType.MONSTRO}.0`, // 20.0
   `${EntityType.FAMINE}.0`, // 63.0
-  `${EntityType.DUKE}.${DukeVariant.DUKE_OF_FLIES}`, // 67.0
+  `${EntityType.DUKE_OF_FLIES}.${DukeOfFliesVariant.DUKE_OF_FLIES}`, // 67.0
   `${EntityType.GEMINI}.${GeminiVariant.GEMINI}`, // 79.0
   `${EntityType.GEMINI}.${GeminiVariant.STEVEN}`, // 79.1
   `${EntityType.FALLEN}.${FallenVariant.FALLEN}`, // 81.0
@@ -153,7 +153,7 @@ const CATACOMBS_BOSSES_SET: ReadonlySet<string> = new Set([
   `${EntityType.CHUB}.${ChubVariant.CARRION_QUEEN}`, // 28.2
   `${EntityType.PIN}.${PinVariant.FRAIL}`, // 62.2
   `${EntityType.PESTILENCE}.0`, // 64.0
-  `${EntityType.DUKE}.${DukeVariant.THE_HUSK}`, // 67.1
+  `${EntityType.DUKE_OF_FLIES}.${DukeOfFliesVariant.THE_HUSK}`, // 67.1
   `${EntityType.PEEP}.${PeepVariant.PEEP}`, // 68.0
   `${EntityType.FALLEN}.${FallenVariant.FALLEN}`, // 81.0
   `${EntityType.HEADLESS_HORSEMAN}.0`, // 82.0

package/src/sets/entitiesWithArmorSet.ts

@@ -33,7 +33,7 @@ import {
  *
  * We use strings instead of a type + variant tuple so that we can have O(1) lookups.
  */
-export const ENTITIES_WITH_ARMOR_SET = new Set([
+export const ENTITIES_WITH_ARMOR_SET: ReadonlySet<string> = new Set([
   `${EntityType.POOTER}.${PooterVariant.TAINTED_POOTER}`, // 14.2
   `${EntityType.HIVE}.${HiveVariant.TAINTED_MULLIGAN}`, // 22.3
   `${EntityType.BOOM_FLY}.${BoomFlyVariant.TAINTED_BOOM_FLY}`, // 25.6