isaacscript-common 87.4.0 → 87.5.1

package/src/functions/array.ts

@@ -35,7 +35,7 @@ export function arrayEquals<T>(
  * matching element. If you want to remove all of the elements, use the `arrayRemoveAll` function
  * instead.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemove<T>(
   originalArray: readonly T[],
   ...elementsToRemove: readonly T[]
@@ -63,7 +63,7 @@ export function arrayRemove<T>(
  * element. If you want to only remove the first matching element, use the `arrayRemove` function
  * instead.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemoveAll<T>(
   originalArray: readonly T[],
   ...elementsToRemove: readonly T[]
@@ -86,11 +86,12 @@ export function arrayRemoveAll<T>(
  * @returns True if one or more elements were removed, false otherwise.
  */
 export function arrayRemoveAllInPlace<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   ...elementsToRemove: readonly T[]
 ): boolean {
   let removedOneOrMoreElements = false;
+
   for (const element of elementsToRemove) {
     let index: number;
     do {
@@ -117,9 +118,9 @@ export function arrayRemoveAllInPlace<T>(
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemoveInPlace<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   ...elementsToRemove: readonly T[]
 ): T[] {
@@ -127,7 +128,7 @@ export function arrayRemoveInPlace<T>(
 
   for (const element of elementsToRemove) {
     const index = array.indexOf(element);
-    if (index > -1) {
+    if (index !== -1) {
       const removedElement = array.splice(index, 1);
       removedElements.push(...removedElement);
     }
@@ -143,7 +144,7 @@ export function arrayRemoveInPlace<T>(
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemoveIndex<T>(
   originalArray: readonly T[],
   ...indexesToRemove: readonly int[]
@@ -168,9 +169,9 @@ export function arrayRemoveIndex<T>(
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemoveIndexInPlace<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   ...indexesToRemove: readonly int[]
 ): T[] {
@@ -212,7 +213,7 @@ export function arrayToString(array: readonly unknown[]): string {
  * This function is variadic, meaning that you can specify N arguments to combine N arrays. Note
  * that this will only perform a shallow copy of the array elements.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function combineArrays<T>(...arrays: ReadonlyArray<readonly T[]>): T[] {
   const elements: T[] = [];
   for (const array of arrays) {
@@ -231,7 +232,7 @@ export function combineArrays<T>(...arrays: ReadonlyArray<readonly T[]>): T[] {
  * @param numElements Optional. If specified, will only copy the first N elements. By default, the
  *                    entire array will be copied.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function copyArray<T>(oldArray: readonly T[], numElements?: int): T[] {
   // Using the spread operator was benchmarked to be faster than manually creating an array using
   // the below algorithm.
@@ -249,9 +250,9 @@ export function copyArray<T>(oldArray: readonly T[], numElements?: int): T[] {
 }
 
 /** Helper function to remove all of the elements in an array in-place. */
-// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
-export function emptyArray<T>(array: T[]): void {
-  array.splice(0, array.length);
+// eslint-disable-next-line complete/prefer-readonly-parameter-types
+export function emptyArray(array: unknown[]): void {
+  array.splice(0);
 }
 
 /**
@@ -265,7 +266,7 @@ export function emptyArray<T>(array: T[]): void {
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function filterMap<OldT, NewT>(
   array: readonly OldT[],
   func: (element: OldT) => NewT | undefined,
@@ -340,6 +341,7 @@ function addCombinations<T>(
   n: number,
   src: readonly T[],
   got: readonly T[],
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   all: Array<readonly T[]>,
 ) {
   if (n === 0) {
@@ -385,7 +387,7 @@ export function getArrayDuplicateElements<T extends number | string>(
  * due to implementation details of TypeScriptToLua, this results in an array of 1 through N
  * (instead of an array of 0 through N -1).
  */
-export function getArrayIndexes<T>(array: readonly T[]): readonly int[] {
+export function getArrayIndexes(array: readonly unknown[]): readonly int[] {
   return eRange(array.length);
 }
 
@@ -482,7 +484,7 @@ export function getRandomArrayElement<T>(
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
 export function getRandomArrayElementAndRemove<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   seedOrRNG: Seed | RNG | undefined,
   exceptions: readonly T[] = [],
@@ -509,8 +511,8 @@ export function getRandomArrayElementAndRemove<T>(
  * @param exceptions Optional. An array of indexes that will be skipped over when getting the random
  *                   index. Default is an empty array.
  */
-export function getRandomArrayIndex<T>(
-  array: readonly T[],
+export function getRandomArrayIndex(
+  array: readonly unknown[],
   seedOrRNG: Seed | RNG | undefined,
   exceptions: readonly int[] = [],
 ): int {
@@ -596,9 +598,7 @@ export function isArray(
 export function isArrayContiguous(array: readonly int[]): boolean {
   let lastValue: int | undefined;
   for (const element of array) {
-    if (lastValue === undefined) {
-      lastValue = element - 1;
-    }
+    lastValue ??= element - 1;
 
     if (element !== lastValue - 1) {
       return false;
@@ -627,7 +627,7 @@ export function isArrayInArray<T>(
 }
 
 /** Helper function to set every element in an array to a specific value. */
-// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
+// eslint-disable-next-line complete/prefer-readonly-parameter-types
 export function setAllArrayElements<T>(array: T[], value: T): void {
   for (let i = 0; i < array.length; i++) {
     array[i] = value;
@@ -647,7 +647,7 @@ export function setAllArrayElements<T>(array: T[], value: T): void {
  *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
  *                  a random seed.
  */
-// eslint-disable-next-line isaacscript/no-mutable-return
+// eslint-disable-next-line complete/no-mutable-return
 export function shuffleArray<T>(
   originalArray: readonly T[],
   seedOrRNG: Seed | RNG | undefined,
@@ -671,9 +671,9 @@ export function shuffleArray<T>(
  *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
  *                  a random seed.
  */
-export function shuffleArrayInPlace<T>(
-  // eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
-  array: T[],
+export function shuffleArrayInPlace(
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
+  array: unknown[],
   seedOrRNG: Seed | RNG | undefined,
 ): void {
   let currentIndex = array.length;
@@ -696,8 +696,12 @@ export function sumArray(array: readonly number[]): number {
 /**
  * Helper function to swap two different array elements. (The elements will be swapped in-place.)
  */
-// eslint-disable-next-line isaacscript/prefer-readonly-parameter-types
-export function swapArrayElements<T>(array: T[], i: number, j: number): void {
+export function swapArrayElements(
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
+  array: unknown[],
+  i: number,
+  j: number,
+): void {
   const value1 = array[i]!; // eslint-disable-line @typescript-eslint/no-non-null-assertion
   const value2 = array[j]!; // eslint-disable-line @typescript-eslint/no-non-null-assertion
 

package/src/functions/arrayLua.ts

@@ -66,7 +66,7 @@ export function forEach<T>(
  *
  * Internally, this just calls `Array.join`.
  */
-export function join<T>(array: readonly T[], separator: string): string {
+export function join(array: readonly unknown[], separator: string): string {
   return array.join(separator);
 }
 

package/src/functions/bosses.ts

@@ -109,7 +109,7 @@ export function getBossID(): BossID | undefined {
 
   const room = game.GetRoom();
 
-  // eslint-disable-next-line deprecation/deprecation
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   const bossID = room.GetBossID();
   if (bossID === 0) {
     return undefined;
@@ -235,6 +235,7 @@ function getNumBossSegments(
 
     // 69
     case EntityType.LOKI: {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
       return variant === LokiVariant.LOKII ? 2 : 1;
     }
 

package/src/functions/charge.ts

@@ -45,8 +45,7 @@ export function addCharge(
   // add too many charges, it will grant orange "battery" charges, even if the player does not have
   // The Battery.)
   const chargesAwayFromMax = getChargesAwayFromMax(player, activeSlot);
-  const chargesToAdd =
-    numCharges > chargesAwayFromMax ? chargesAwayFromMax : numCharges;
+  const chargesToAdd = Math.min(numCharges, chargesAwayFromMax);
 
   // The AAA Battery trinket might grant an additional charge.
   const modifiedChargesToAdd = getChargesToAddWithAAAModifier(

package/src/functions/decorators.ts

@@ -85,13 +85,13 @@ export function PriorityCallback<T extends ModCallback>(
   priority: CallbackPriority | int,
   ...optionalArgs: AllButFirst<AddCallbackParameters[T]>
 ) {
-  return <Class extends ModFeature, Fn extends AddCallbackParameters[T][0]>(
-    target: Class,
+  return <Fn extends AddCallbackParameters[T][0]>(
+    target: ModFeature,
     propertyKey: string,
     _descriptor: TypedPropertyDescriptor<Fn>,
   ): void => {
     // First, prepare the arguments for the `Mod.AddPriorityCallback` method.
-    const methodName = propertyKey as keyof Class;
+    const methodName = propertyKey as keyof ModFeature;
     const method = target[methodName] as AddCallbackParameters[T][0];
     const callbackTuple = [modCallback, priority, method, optionalArgs];
 
@@ -133,16 +133,13 @@ export function PriorityCallbackCustom<T extends ModCallbackCustom>(
   priority: CallbackPriority | int,
   ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>
 ) {
-  return <
-    Class extends ModFeature,
-    Fn extends AddCallbackParametersCustom[T][0],
-  >(
-    target: Class,
+  return <Fn extends AddCallbackParametersCustom[T][0]>(
+    target: ModFeature,
     propertyKey: string,
     _descriptor: TypedPropertyDescriptor<Fn>,
   ): void => {
     // First, prepare the arguments for the `Mod.AddCallbackCustom` method.
-    const methodName = propertyKey as keyof Class;
+    const methodName = propertyKey as keyof ModFeature;
     const method = target[methodName] as AddCallbackParametersCustom[T][0];
     const callbackTuple = [modCallbackCustom, priority, method, optionalArgs];
 

package/src/functions/deepCopy.ts

@@ -320,8 +320,6 @@ function deepCopyDefaultMap(
     }
   }
 
-  insideMap = false;
-
   return newDefaultMap;
 }
 
@@ -421,8 +419,6 @@ function deepCopyMap(
     }
   }
 
-  insideMap = false;
-
   return newMap;
 }
 

package/src/functions/deepCopyTests.ts

@@ -203,21 +203,21 @@ function copiedObjectHasNoReferencesForArray() {
     error("The copied object does not have an equal array.");
   }
 
-  oldObject.abc[0]++;
+  oldObject.abc[0]!++; // eslint-disable-line @typescript-eslint/no-non-null-assertion
   if (arrayEquals(oldObject.abc, newObject.abc)) {
     error(
       "The copied object has an equal array after a modification to the old array.",
     );
   }
-  oldObject.abc[0]--;
+  oldObject.abc[0]!--; // eslint-disable-line @typescript-eslint/no-non-null-assertion
 
-  newObject.abc[0]++;
+  newObject.abc[0]!++; // eslint-disable-line @typescript-eslint/no-non-null-assertion
   if (arrayEquals(oldObject.abc, newObject.abc)) {
     error(
       "The copied object has an equal array after a modification to the new array.",
     );
   }
-  newObject.abc[0]--;
+  newObject.abc[0]!--; // eslint-disable-line @typescript-eslint/no-non-null-assertion
 }
 
 function copiedObjectHasChildObject() {

package/src/functions/doors.ts

@@ -377,6 +377,7 @@ export function isAngelRoomDoor(door: GridEntityDoor): boolean {
  * Room.)
  */
 export function isBlueWombDoor(door: GridEntityDoor): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return door.TargetRoomIndex === GridRoom.BLUE_WOMB;
 }
 
@@ -385,6 +386,7 @@ export function isBlueWombDoor(door: GridEntityDoor): boolean {
  * vanilla, the door will only appear in the Boss Room of the sixth floor.)
  */
 export function isBossRushDoor(door: GridEntityDoor): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return door.TargetRoomIndex === GridRoom.BOSS_RUSH;
 }
 
@@ -493,6 +495,7 @@ export function isHiddenSecretRoomDoor(door: GridEntityDoor): boolean {
  * (In vanilla, the door will only appear in the starting room of The Chest / Dark Room.)
  */
 export function isMegaSatanDoor(door: GridEntityDoor): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return door.TargetRoomIndex === GridRoom.MEGA_SATAN;
 }
 
@@ -501,6 +504,7 @@ export function isMegaSatanDoor(door: GridEntityDoor): boolean {
  * you to the Repentance floor.
  */
 export function isRepentanceDoor(door: GridEntityDoor): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return door.TargetRoomIndex === GridRoom.SECRET_EXIT;
 }
 
@@ -525,6 +529,7 @@ export function isSecretRoomDoor(door: GridEntityDoor): boolean {
  * contains the portal to The Void. (In vanilla, the door will only appear in the Hush Boss Room.)
  */
 export function isVoidDoor(door: GridEntityDoor): boolean {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
   return door.TargetRoomIndex === GridRoom.VOID;
 }
 

package/src/functions/entities.ts

@@ -425,6 +425,7 @@ export function isActiveEnemy(entity: Entity): boolean {
 
       // 912
       case EntityType.MOTHER: {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
         if (entity.Variant === MotherVariant.MOTHER_1) {
           const npc = entity.ToNPC();
           if (npc !== undefined && npc.State === NPCState.SPECIAL) {
@@ -441,7 +442,7 @@ export function isActiveEnemy(entity: Entity): boolean {
     }
   }
 
-  // eslint-disable-next-line deprecation/deprecation
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   return entity.IsActiveEnemy(false);
 }
 
@@ -640,8 +641,8 @@ export function setEntityRandomColor(entity: Entity): void {
 }
 
 /**
- * Helper function to spawn an entity. Use this instead of the `Isaac.Spawn` method if you do not
- * need to specify the velocity or spawner.
+ * Helper function to spawn an entity. Always use this instead of the `Isaac.Spawn` method, since
+ * using that method can crash the game.
  *
  * Also see the `spawnWithSeed` helper function.
  *
@@ -653,7 +654,7 @@ export function setEntityRandomColor(entity: Entity): void {
  * @param spawner Optional. The entity that will be the `SpawnerEntity`. Default is undefined.
  * @param seedOrRNG Optional. The seed or RNG object to use to generate the `InitSeed` of the
  *                  entity. Default is undefined, which will make the entity spawn with a random
- *                  seed using the `Isaac.Spawn` method.
+ *                  seed.
  */
 export function spawn(
   entityType: EntityType,
@@ -666,6 +667,7 @@ export function spawn(
 ): Entity {
   const room = game.GetRoom();
 
+  // We do an explicit check to prevent run-time errors in Lua environments.
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (positionOrGridIndex === undefined) {
     const entityID = getEntityIDFromConstituents(entityType, variant, subType);
@@ -678,16 +680,7 @@ export function spawn(
     ? positionOrGridIndex
     : room.GetGridPosition(positionOrGridIndex);
 
-  if (seedOrRNG === undefined) {
-    return Isaac.Spawn(
-      entityType,
-      variant,
-      subType,
-      position,
-      velocity,
-      spawner,
-    );
-  }
+  seedOrRNG ??= newRNG();
 
   const seed = isRNG(seedOrRNG) ? seedOrRNG.Next() : seedOrRNG;
   return game.Spawn(

package/src/functions/enums.ts

@@ -230,7 +230,7 @@ export function getRandomEnumValue<T extends TranspiledEnum>(
  * `satisfies` operator with the `Record` type instead.
  */
 export function interfaceSatisfiesEnum<
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-unnecessary-type-parameters
   T extends Record<Enum, unknown>,
   Enum extends string | number,
 >(): void {} // eslint-disable-line @typescript-eslint/no-empty-function
@@ -277,9 +277,9 @@ export function validateCustomEnum(
  *
  * This is useful to automate checking large enums for typos.
  */
-export function validateEnumContiguous<T extends TranspiledEnum>(
+export function validateEnumContiguous(
   transpiledEnumName: string,
-  transpiledEnum: T,
+  transpiledEnum: TranspiledEnum,
 ): void {
   const values = getEnumValues(transpiledEnum);
   const lastValue = values.at(-1);
@@ -296,7 +296,7 @@ export function validateEnumContiguous<T extends TranspiledEnum>(
 
   const valuesSet = new ReadonlySet(values);
   for (const value of iRange(lastValue)) {
-    if (!valuesSet.has(value as unknown as T[keyof T])) {
+    if (!valuesSet.has(value)) {
       error(
         `Failed to find a custom enum value of ${value} for: ${transpiledEnumName}`,
       );

package/src/functions/flag.ts

@@ -115,7 +115,7 @@ export function hasFlag<T extends BitFlag | BitFlag128>(
  * (This is equivalent to checking if the flag is equal to 0, but this is not possible without
  * casting the flag to a number.)
  */
-export function isEmptyFlag<T extends BitFlag | BitFlag128>(flag: T): boolean {
+export function isEmptyFlag(flag: BitFlag | BitFlag128): boolean {
   return flag === 0;
 }
 

package/src/functions/globals.ts

@@ -220,8 +220,7 @@ export function getNewGlobals(): ReadonlyArray<[AnyNotNil, unknown]> {
   const newGlobals: Array<[AnyNotNil, unknown]> = [];
   for (const [key, value] of pairs(_G)) {
     if (!defaultGlobals.has(key)) {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const keyValueTuple: [AnyNotNil, unknown] = [key, value as any];
+      const keyValueTuple: [AnyNotNil, unknown] = [key, value];
       newGlobals.push(keyValueTuple);
     }
   }
@@ -256,7 +255,7 @@ export function setLogFunctionsGlobal(): void {
   const globals = _G as Record<string, unknown>;
 
   for (const exports of [logExports, logMiscExports, logEntitiesExports]) {
-    // eslint-disable-next-line isaacscript/no-object-any
+    // eslint-disable-next-line complete/no-object-any
     for (const [logFuncName, logFunc] of Object.entries(exports)) {
       globals[logFuncName] = logFunc;
     }

package/src/functions/gridEntities.ts

@@ -816,7 +816,7 @@ export function isGridEntityBroken(gridEntity: GridEntity): boolean {
  * the `PRE_ROOM_ENTITY_SPAWN` callback for narrowing the type of the first argument.
  */
 export function isGridEntityXMLType(num: number): num is GridEntityXMLType {
-  return GRID_ENTITY_XML_TYPES_SET.has(num); // eslint-disable-line isaacscript/strict-enums
+  return GRID_ENTITY_XML_TYPES_SET.has(num); // eslint-disable-line complete/strict-enums
 }
 
 /**
@@ -861,6 +861,7 @@ export function isPostBossVoidPortal(gridEntity: GridEntity): boolean {
 
   return (
     saveState.Type === GridEntityType.TRAPDOOR &&
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     saveState.Variant === TrapdoorVariant.VOID_PORTAL &&
     saveState.VarData === 1
   );
@@ -1042,6 +1043,7 @@ export function removeGridEntity(
   // corresponding effect.
   if (gridEntityType === GridEntityType.STATUE) {
     const effectVariant =
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
       variant === StatueVariant.DEVIL
         ? EffectVariant.DEVIL
         : EffectVariant.ANGEL;
@@ -1147,15 +1149,19 @@ export function spawnGiantPoop(topLeftGridIndex: int): boolean {
   return (
     topLeft !== undefined &&
     topLeft.GetType() === GridEntityType.POOP &&
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     topLeft.GetVariant() === PoopGridEntityVariant.GIANT_TOP_LEFT &&
     topRight !== undefined &&
     topRight.GetType() === GridEntityType.POOP &&
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     topRight.GetVariant() === PoopGridEntityVariant.GIANT_TOP_RIGHT &&
     bottomLeft !== undefined &&
     bottomLeft.GetType() === GridEntityType.POOP &&
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     bottomLeft.GetVariant() === PoopGridEntityVariant.GIANT_BOTTOM_LEFT &&
     bottomRight !== undefined &&
     bottomRight.GetType() === GridEntityType.POOP &&
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
     bottomRight.GetVariant() === PoopGridEntityVariant.GIANT_BOTTOM_RIGHT
   );
 }
@@ -1219,6 +1225,18 @@ export function spawnGridEntityWithVariant(
 ): GridEntity | undefined {
   const room = game.GetRoom();
 
+  // We do an explicit check to prevent run-time errors in Lua environments.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  if (gridIndexOrPosition === undefined) {
+    const gridEntityID = getGridEntityIDFromConstituents(
+      gridEntityType,
+      variant,
+    );
+    error(
+      `Failed to spawn grid entity ${gridEntityID} since an undefined position was passed to the "spawnGridEntityWithVariant" function.`,
+    );
+  }
+
   const existingGridEntity = isVector(gridIndexOrPosition)
     ? room.GetGridEntityFromPos(gridIndexOrPosition)
     : room.GetGridEntity(gridIndexOrPosition);

package/src/functions/jsonHelpers.ts

@@ -13,19 +13,21 @@ function tryEncode(this: void, luaTable: unknown) {
  * Converts a JSON string to a Lua table.
  *
  * In most cases, this function will be used for reading data from a "save#.dat" file. If decoding
- * fails, it will return a blank Lua table instead of throwing an error. (This allows execution to
- * continue in cases where users have no current save data or have manually removed their existing
- * save data.)
+ * fails, it will return undefined instead of throwing an error. (This allows execution to continue
+ * in cases where users have no current save data or have manually removed their existing save
+ * data.)
  *
  * Under the hood, this uses a custom JSON parser that was measured to be 11.8 times faster than the
  * vanilla JSON parser.
  */
-export function jsonDecode(jsonString: string): LuaMap<AnyNotNil, unknown> {
+export function jsonDecode(
+  jsonString: string,
+): LuaMap<AnyNotNil, unknown> | undefined {
   const [ok, luaTableOrErrMsg] = pcall(tryDecode, jsonString);
   if (!ok) {
     // Instead of throwing an error, continue execution of the callback.
     logError(`Failed to convert the JSON string to a Lua table: ${jsonString}`);
-    return new LuaMap();
+    return undefined;
   }
 
   return luaTableOrErrMsg;

package/src/functions/levelGrid.ts

@@ -531,9 +531,7 @@ export function isRedKeyRoom(roomGridIndex: int): boolean {
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export function isRoomInsideGrid(roomGridIndex?: int): boolean {
-  if (roomGridIndex === undefined) {
-    roomGridIndex = getRoomGridIndex();
-  }
+  roomGridIndex ??= getRoomGridIndex();
 
   return roomGridIndex >= 0 && roomGridIndex <= MAX_LEVEL_GRID_INDEX;
 }
@@ -567,9 +565,8 @@ export function newRoom(
 ): int | undefined {
   const level = game.GetLevel();
 
-  if (seedOrRNG === undefined) {
-    seedOrRNG = level.GetDungeonPlacementSeed();
-  }
+  seedOrRNG ??= level.GetDungeonPlacementSeed();
+
   const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
 
   const newRoomCandidate = getNewRoomCandidate(rng, ensureDeadEnd);

package/src/functions/logEntities.ts

@@ -222,8 +222,11 @@ function getEntityLogLine(this: void, entity: Entity, num?: int): string {
   msg += `  - Position: (${entity.Position.X}, ${entity.Position.Y})\n`;
   msg += `  - Velocity: (${entity.Velocity.X}, ${entity.Velocity.Y})\n`;
   msg += `  - HP: ${entity.HitPoints} / ${entity.MaxHitPoints}\n`;
+  // eslint-disable-next-line @typescript-eslint/no-base-to-string
   msg += `  - Parent: ${entity.Parent}\n`;
+  // eslint-disable-next-line @typescript-eslint/no-base-to-string
   msg += `  - Child: ${entity.Child}\n`;
+  // eslint-disable-next-line @typescript-eslint/no-base-to-string
   msg += `  - SpawnerEntity: ${entity.SpawnerEntity}\n`;
   msg += `  - SpawnerType / SpawnerVariant: ${entity.SpawnerType}.${entity.SpawnerVariant}\n`;
   msg += `  - FrameCount: ${entity.FrameCount}\n`;