isaacscript-common 87.9.5 → 87.9.7

package/src/classes/features/other/debugDisplay/DebugDisplayTear.ts

@@ -4,6 +4,12 @@ import { Feature } from "../../../private/Feature";
 import { defaultEntityDisplayCallback } from "./utils";
 
 export class DebugDisplayTear extends Feature {
+  // ModCallback.POST_TEAR_RENDER (41)
+  private readonly postTearRender = (tear: EntityTear) => {
+    const text = this.textCallback(tear);
+    renderTextOnEntity(tear, text);
+  };
+
   public textCallback: (tear: EntityTear) => string =
     defaultEntityDisplayCallback;
 
@@ -15,10 +21,4 @@ export class DebugDisplayTear extends Feature {
       [ModCallback.POST_TEAR_RENDER, this.postTearRender],
     ];
   }
-
-  // ModCallback.POST_TEAR_RENDER (41)
-  private readonly postTearRender = (tear: EntityTear) => {
-    const text = this.textCallback(tear);
-    renderTextOnEntity(tear, text);
-  };
 }

package/src/classes/features/other/extraConsoleCommands/commands.ts

@@ -1,15 +1,7 @@
 // cspell:ignore addcharges
 
-/*
-eslint "sort-exports/sort-exports": [
-  "warn",
-  {
-    sortDir: "asc",
-  },
-],
-*/
-
-/* eslint "jsdoc/require-jsdoc": "warn" */
+/* eslint "perfectionist/sort-modules": "error" */
+/* eslint "jsdoc/require-jsdoc": "error" */
 
 /**
  * __DOCS_LINE_THAT_WILL_BE_AUTOMATICALLY_REMOVED__
@@ -334,14 +326,12 @@ export function bossRoom(): void {
   const roomType = RoomType.BOSS;
   const roomGridIndexes = getRoomGridIndexesForType(roomType);
 
-  let roomGridIndex = roomGridIndexes[0];
-
-  if (onStage(LevelStage.VOID)) {
-    roomGridIndex = roomGridIndexes.find(
-      (thisRoomGridIndex) =>
-        getRoomData(thisRoomGridIndex)?.Subtype === BossID.DELIRIUM,
-    );
-  }
+  const roomGridIndex = onStage(LevelStage.VOID)
+    ? roomGridIndexes.find(
+        (thisRoomGridIndex) =>
+          getRoomData(thisRoomGridIndex)?.Subtype === BossID.DELIRIUM,
+      )
+    : roomGridIndexes[0];
 
   const roomTypeName = ROOM_TYPE_NAMES[RoomType.BOSS];
   if (roomGridIndex === undefined) {
@@ -757,26 +747,6 @@ export function goldBomb(): void {
   goldenBomb();
 }
 
-/** Alias for the "goldenHearts" command. */
-export function goldHearts(params: string): void {
-  goldenHearts(params);
-}
-
-/** Alias for the "goldenKey" command. */
-export function goldKey(): void {
-  goldenKey();
-}
-
-/** Alias for the "goldenPill" command. */
-export function goldPill(): void {
-  goldenPill();
-}
-
-/** Alias for the "spawnGoldenTrinket" command. */
-export function goldTrinket(params: string): void {
-  spawnGoldenTrinket(params);
-}
-
 /** Gives the player a golden bomb. */
 export function goldenBomb(): void {
   const player = Isaac.GetPlayer();
@@ -808,6 +778,26 @@ export function goldenTrinket(params: string): void {
   spawnGoldenTrinket(params);
 }
 
+/** Alias for the "goldenHearts" command. */
+export function goldHearts(params: string): void {
+  goldenHearts(params);
+}
+
+/** Alias for the "goldenKey" command. */
+export function goldKey(): void {
+  goldenKey();
+}
+
+/** Alias for the "goldenPill" command. */
+export function goldPill(): void {
+  goldenPill();
+}
+
+/** Alias for the "spawnGoldenTrinket" command. */
+export function goldTrinket(params: string): void {
+  spawnGoldenTrinket(params);
+}
+
 /**
  * Alias for the "debug 11" command. Useful for seeing the coordinates and grid index of each tile
  * in the room.
@@ -1297,6 +1287,12 @@ export function secretShop(): void {
   changeRoom(GridRoom.SECRET_SHOP);
 }
 
+/** Logs all of the current run's seed effects to the "log.txt" file. */
+export function seeds(): void {
+  logSeedEffects();
+  print('Logged the seed effects to the "log.txt" file.');
+}
+
 /** Changes to a seeded run, using the seed of the current run. */
 export function seedStick(): void {
   const seedsClass = game.GetSeeds();
@@ -1305,12 +1301,6 @@ export function seedStick(): void {
   print(`Sticking to seed: ${startSeedString}`);
 }
 
-/** Logs all of the current run's seed effects to the "log.txt" file. */
-export function seeds(): void {
-  logSeedEffects();
-  print('Logged the seed effects to the "log.txt" file.');
-}
-
 /**
  * Sets a charge to the player's specified active item. You must provide the active slot number and
  * the number of charges to set.
@@ -1569,11 +1559,6 @@ export function spawnCollectibleAt(params: string): void {
   spawnCollectibleFunc(collectibleType, gridIndex, undefined);
 }
 
-/** Alias for the `spawnGoldenTrinket` command. */
-export function spawnGoldTrinket(params: string): void {
-  spawnGoldenTrinket(params);
-}
-
 /**
  * The same thing as the `spawnTrinket` command but spawns a golden version of the specified
  * trinket.
@@ -1590,6 +1575,11 @@ export function spawnGoldenTrinketAt(params: string): void {
   spawnTrinketAt(params, true);
 }
 
+/** Alias for the `spawnGoldenTrinket` command. */
+export function spawnGoldTrinket(params: string): void {
+  spawnGoldenTrinket(params);
+}
+
 /**
  * Spawns a trinket in the center of the room. You must specify the trinket name or the number
  * corresponding to the trinket type.
@@ -1728,11 +1718,6 @@ export function spikes(): void {
   spawnGridEntity(GridEntityType.SPIKES, tilePosition);
 }
 
-/** Alias for the "startingRoom" command. */
-export function startRoom(): void {
-  startingRoom();
-}
-
 /** Warps to the starting room of the floor. */
 export function startingRoom(): void {
   const level = game.GetLevel();
@@ -1740,6 +1725,11 @@ export function startingRoom(): void {
   changeRoom(startingRoomIndex);
 }
 
+/** Alias for the "startingRoom" command. */
+export function startRoom(): void {
+  startingRoom();
+}
+
 /** Warps to the first Super Secret Room on the floor. */
 export function superSecretRoom(): void {
   warpToRoomType(RoomType.SUPER_SECRET);

package/src/classes/private/CustomCallback.ts

@@ -15,9 +15,9 @@ export type OptionalArgs<T extends ModCallbackCustom> = AllButFirst<
 >;
 
 interface Subscription<T extends ModCallbackCustom> {
-  priority: CallbackPriority | int;
-  callbackFunc: AddCallbackParametersCustom[T][0];
-  optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>;
+  readonly priority: CallbackPriority | int;
+  readonly callbackFunc: AddCallbackParametersCustom[T][0];
+  readonly optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>;
 }
 
 /**
@@ -29,43 +29,6 @@ export abstract class CustomCallback<
 > extends Feature {
   private subscriptions: Array<Subscription<T>> = [];
 
-  public addSubscriber(
-    priority: CallbackPriority | int,
-    callbackFunc: AddCallbackParametersCustom[T][0],
-    ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>
-  ): void {
-    const subscription: Subscription<T> = {
-      priority,
-      callbackFunc,
-      optionalArgs,
-    };
-    this.subscriptions.push(subscription);
-
-    // Sort the subscriptions by priority so that the callbacks with the lowest priority are first.
-    // By default, the `Array.sort` method is transpiled to using Lua's sort, which is not stable.
-    // We need to do a stable sort so that we preserve the subscription order.
-    this.subscriptions = stableSort(
-      this.subscriptions,
-      sortObjectArrayByKey("priority"),
-    );
-  }
-
-  /**
-   * If the submitted function does not match any of the existing subscriptions, this method will do
-   * nothing.
-   */
-  public removeSubscriber(callback: AddCallbackParametersCustom[T][0]): void {
-    const subscriptionIndexMatchingCallback = this.subscriptions.findIndex(
-      (subscription) => {
-        const subscriptionCallback = subscription.callbackFunc;
-        return callback === subscriptionCallback;
-      },
-    );
-    if (subscriptionIndexMatchingCallback !== -1) {
-      this.subscriptions.splice(subscriptionIndexMatchingCallback, 1);
-    }
-  }
-
   public fire = (
     ...fireArgs: FireArgs<T>
   ): ReturnType<AddCallbackParametersCustom[T][0]> => {
@@ -103,4 +66,41 @@ export abstract class CustomCallback<
     fireArgs: FireArgs<T>,
     optionalArgs: OptionalArgs<T>,
   ) => boolean = () => true;
+
+  public addSubscriber(
+    priority: CallbackPriority | int,
+    callbackFunc: AddCallbackParametersCustom[T][0],
+    ...optionalArgs: AllButFirst<AddCallbackParametersCustom[T]>
+  ): void {
+    const subscription: Subscription<T> = {
+      priority,
+      callbackFunc,
+      optionalArgs,
+    };
+    this.subscriptions.push(subscription);
+
+    // Sort the subscriptions by priority so that the callbacks with the lowest priority are first.
+    // By default, the `Array.sort` method is transpiled to using Lua's sort, which is not stable.
+    // We need to do a stable sort so that we preserve the subscription order.
+    this.subscriptions = stableSort(
+      this.subscriptions,
+      sortObjectArrayByKey("priority"),
+    );
+  }
+
+  /**
+   * If the submitted function does not match any of the existing subscriptions, this method will do
+   * nothing.
+   */
+  public removeSubscriber(callback: AddCallbackParametersCustom[T][0]): void {
+    const subscriptionIndexMatchingCallback = this.subscriptions.findIndex(
+      (subscription) => {
+        const subscriptionCallback = subscription.callbackFunc;
+        return callback === subscriptionCallback;
+      },
+    );
+    if (subscriptionIndexMatchingCallback !== -1) {
+      this.subscriptions.splice(subscriptionIndexMatchingCallback, 1);
+    }
+  }
 }

package/src/core/cachedClasses.ts

@@ -1,3 +1,5 @@
+/* eslint-disable unicorn/no-top-level-side-effects */
+
 /**
  * A cached version of the class returned from the `Game()` constructor.
  *

package/src/core/constants.ts

@@ -38,7 +38,7 @@ export const ALL_DISPLAY_FLAGS = addFlag(
 export const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
 
 /**
- * The path to the png file for collectible items during Curse of the Blind, making them appear with
+ * The path to the PNG file for collectible items during Curse of the Blind, making them appear with
  * a red question mark.
  */
 export const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
@@ -279,9 +279,7 @@ export const NUM_DIMENSIONS = getEnumLength(Dimension) - 1;
  *
  * We cannot use the values of the `Dimension` enum because it includes -1.
  */
-export const DIMENSIONS: readonly Dimension[] = eRange(
-  NUM_DIMENSIONS,
-) as Dimension[];
+export const DIMENSIONS = eRange(NUM_DIMENSIONS) as readonly Dimension[];
 
 /**
  * The pill pool for each run is comprised of one effect for each unique pill color (minus gold and

package/src/decorators.ts

@@ -16,8 +16,7 @@ export function Exported<Class extends Feature>(
   // Since the decorator runs prior to instantiation, we only have access to get and set static
   // properties, which are located on the "constructor" table.
   const constructor = target.constructor as unknown as
-    | Record<string, unknown>
-    | undefined;
+    Record<string, unknown> | undefined;
 
   if (constructor === undefined) {
     const tstlClassName = getTSTLClassName(target) ?? "Unknown";
@@ -27,12 +26,11 @@ export function Exported<Class extends Feature>(
   }
 
   let exportedMethodNames = constructor[EXPORTED_METHOD_NAMES_KEY] as
-    | unknown[]
-    | undefined;
+    unknown[] | undefined;
   if (exportedMethodNames === undefined) {
     exportedMethodNames = [];
     constructor[EXPORTED_METHOD_NAMES_KEY] = exportedMethodNames;
   }
 
-  exportedMethodNames.push(propertyKey as string);
+  exportedMethodNames.push(propertyKey);
 }

package/src/features.ts

@@ -62,69 +62,71 @@ import { ModCallbackCustom } from "./enums/ModCallbackCustom";
 import { interfaceSatisfiesEnum } from "./functions/enums";
 import type { ModUpgradedInterface } from "./interfaces/private/ModUpgradedInterface";
 
+// eslint-disable-next-line complete/type-declaration-immutability
 export interface ISCFeatureToClass {
   // Callback logic
-  [ISCFeature.CUSTOM_REVIVE]: CustomRevive;
-  [ISCFeature.ESAU_JR_DETECTION]: EsauJrDetection;
-  [ISCFeature.FLIP_DETECTION]: FlipDetection;
-  [ISCFeature.GRID_ENTITY_COLLISION_DETECTION]: GridEntityCollisionDetection;
-  [ISCFeature.GRID_ENTITY_RENDER_DETECTION]: GridEntityRenderDetection;
-  [ISCFeature.GRID_ENTITY_UPDATE_DETECTION]: GridEntityUpdateDetection;
-  [ISCFeature.GAME_REORDERED_CALLBACKS]: GameReorderedCallbacks;
-  [ISCFeature.ITEM_PICKUP_DETECTION]: ItemPickupDetection;
-  [ISCFeature.PICKUP_CHANGE_DETECTION]: PickupChangeDetection;
-  [ISCFeature.PLAYER_COLLECTIBLE_DETECTION]: PlayerCollectibleDetection;
-  [ISCFeature.PLAYER_REORDERED_CALLBACKS]: PlayerReorderedCallbacks;
-  [ISCFeature.SLOT_DESTROYED_DETECTION]: SlotDestroyedDetection;
-  [ISCFeature.SLOT_RENDER_DETECTION]: SlotRenderDetection;
-  [ISCFeature.SLOT_UPDATE_DETECTION]: SlotUpdateDetection;
+  readonly [ISCFeature.CUSTOM_REVIVE]: CustomRevive;
+  readonly [ISCFeature.ESAU_JR_DETECTION]: EsauJrDetection;
+  readonly [ISCFeature.FLIP_DETECTION]: FlipDetection;
+  readonly [ISCFeature.GRID_ENTITY_COLLISION_DETECTION]: GridEntityCollisionDetection;
+  readonly [ISCFeature.GRID_ENTITY_RENDER_DETECTION]: GridEntityRenderDetection;
+  readonly [ISCFeature.GRID_ENTITY_UPDATE_DETECTION]: GridEntityUpdateDetection;
+  readonly [ISCFeature.GAME_REORDERED_CALLBACKS]: GameReorderedCallbacks;
+  readonly [ISCFeature.ITEM_PICKUP_DETECTION]: ItemPickupDetection;
+  readonly [ISCFeature.PICKUP_CHANGE_DETECTION]: PickupChangeDetection;
+  readonly [ISCFeature.PLAYER_COLLECTIBLE_DETECTION]: PlayerCollectibleDetection;
+  readonly [ISCFeature.PLAYER_REORDERED_CALLBACKS]: PlayerReorderedCallbacks;
+  readonly [ISCFeature.SLOT_DESTROYED_DETECTION]: SlotDestroyedDetection;
+  readonly [ISCFeature.SLOT_RENDER_DETECTION]: SlotRenderDetection;
+  readonly [ISCFeature.SLOT_UPDATE_DETECTION]: SlotUpdateDetection;
 
   // Extra features
-  [ISCFeature.CHARACTER_HEALTH_CONVERSION]: CharacterHealthConversion;
-  [ISCFeature.CHARACTER_STATS]: CharacterStats;
-  [ISCFeature.COLLECTIBLE_ITEM_POOL_TYPE]: CollectibleItemPoolType;
-  [ISCFeature.CUSTOM_GRID_ENTITIES]: CustomGridEntities;
-  [ISCFeature.CUSTOM_ITEM_POOLS]: CustomItemPools;
-  [ISCFeature.CUSTOM_HOTKEYS]: CustomHotkeys;
-  [ISCFeature.CUSTOM_PICKUPS]: CustomPickups;
-  [ISCFeature.CUSTOM_STAGES]: CustomStages;
-  [ISCFeature.CUSTOM_TRAPDOORS]: CustomTrapdoors;
-  [ISCFeature.DEBUG_DISPLAY]: DebugDisplay;
-  [ISCFeature.DEPLOY_JSON_ROOM]: DeployJSONRoom;
-  [ISCFeature.DISABLE_ALL_SOUND]: DisableAllSound;
-  [ISCFeature.DISABLE_INPUTS]: DisableInputs;
-  [ISCFeature.EDEN_STARTING_STATS_HEALTH]: EdenStartingStatsHealth;
-  [ISCFeature.FADE_IN_REMOVER]: FadeInRemover;
-  [ISCFeature.FAST_RESET]: FastReset;
-  [ISCFeature.FLYING_DETECTION]: FlyingDetection;
-  [ISCFeature.FORGOTTEN_SWITCH]: ForgottenSwitch;
-  [ISCFeature.EXTRA_CONSOLE_COMMANDS]: ExtraConsoleCommands;
-  [ISCFeature.ITEM_POOL_DETECTION]: ItemPoolDetection;
-  [ISCFeature.MODDED_ELEMENT_DETECTION]: ModdedElementDetection;
-  [ISCFeature.MODDED_ELEMENT_SETS]: ModdedElementSets;
-  [ISCFeature.NO_SIREN_STEAL]: NoSirenSteal;
-  [ISCFeature.PAUSE]: Pause;
-  [ISCFeature.PERSISTENT_ENTITIES]: PersistentEntities;
-  [ISCFeature.PICKUP_INDEX_CREATION]: PickupIndexCreation;
-  [ISCFeature.PLAYER_COLLECTIBLE_TRACKING]: PlayerCollectibleTracking;
-  [ISCFeature.PONY_DETECTION]: PonyDetection;
-  [ISCFeature.PRESS_INPUT]: PressInput;
-  [ISCFeature.PREVENT_CHILD_ENTITIES]: PreventChildEntities;
-  [ISCFeature.PREVENT_GRID_ENTITY_RESPAWN]: PreventGridEntityRespawn;
-  [ISCFeature.RERUN_DETECTION]: RerunDetection;
-  [ISCFeature.ROOM_CLEAR_FRAME]: RoomClearFrame;
-  [ISCFeature.ROOM_HISTORY]: RoomHistory;
-  [ISCFeature.RUN_IN_N_FRAMES]: RunInNFrames;
-  [ISCFeature.RUN_NEXT_ROOM]: RunNextRoom;
-  [ISCFeature.RUN_NEXT_RUN]: RunNextRun;
-  [ISCFeature.SAVE_DATA_MANAGER]: SaveDataManager;
-  [ISCFeature.SPAWN_ALT_ROCK_REWARDS]: SpawnRockAltRewards;
-  [ISCFeature.STAGE_HISTORY]: StageHistory;
-  [ISCFeature.START_AMBUSH]: StartAmbush;
-  [ISCFeature.TAINTED_LAZARUS_PLAYERS]: TaintedLazarusPlayers;
-  [ISCFeature.UNLOCK_ACHIEVEMENTS_DETECTION]: UnlockAchievementsDetection;
+  readonly [ISCFeature.CHARACTER_HEALTH_CONVERSION]: CharacterHealthConversion;
+  readonly [ISCFeature.CHARACTER_STATS]: CharacterStats;
+  readonly [ISCFeature.COLLECTIBLE_ITEM_POOL_TYPE]: CollectibleItemPoolType;
+  readonly [ISCFeature.CUSTOM_GRID_ENTITIES]: CustomGridEntities;
+  readonly [ISCFeature.CUSTOM_ITEM_POOLS]: CustomItemPools;
+  readonly [ISCFeature.CUSTOM_HOTKEYS]: CustomHotkeys;
+  readonly [ISCFeature.CUSTOM_PICKUPS]: CustomPickups;
+  readonly [ISCFeature.CUSTOM_STAGES]: CustomStages;
+  readonly [ISCFeature.CUSTOM_TRAPDOORS]: CustomTrapdoors;
+  readonly [ISCFeature.DEBUG_DISPLAY]: DebugDisplay;
+  readonly [ISCFeature.DEPLOY_JSON_ROOM]: DeployJSONRoom;
+  readonly [ISCFeature.DISABLE_ALL_SOUND]: DisableAllSound;
+  readonly [ISCFeature.DISABLE_INPUTS]: DisableInputs;
+  readonly [ISCFeature.EDEN_STARTING_STATS_HEALTH]: EdenStartingStatsHealth;
+  readonly [ISCFeature.FADE_IN_REMOVER]: FadeInRemover;
+  readonly [ISCFeature.FAST_RESET]: FastReset;
+  readonly [ISCFeature.FLYING_DETECTION]: FlyingDetection;
+  readonly [ISCFeature.FORGOTTEN_SWITCH]: ForgottenSwitch;
+  readonly [ISCFeature.EXTRA_CONSOLE_COMMANDS]: ExtraConsoleCommands;
+  readonly [ISCFeature.ITEM_POOL_DETECTION]: ItemPoolDetection;
+  readonly [ISCFeature.MODDED_ELEMENT_DETECTION]: ModdedElementDetection;
+  readonly [ISCFeature.MODDED_ELEMENT_SETS]: ModdedElementSets;
+  readonly [ISCFeature.NO_SIREN_STEAL]: NoSirenSteal;
+  readonly [ISCFeature.PAUSE]: Pause;
+  readonly [ISCFeature.PERSISTENT_ENTITIES]: PersistentEntities;
+  readonly [ISCFeature.PICKUP_INDEX_CREATION]: PickupIndexCreation;
+  readonly [ISCFeature.PLAYER_COLLECTIBLE_TRACKING]: PlayerCollectibleTracking;
+  readonly [ISCFeature.PONY_DETECTION]: PonyDetection;
+  readonly [ISCFeature.PRESS_INPUT]: PressInput;
+  readonly [ISCFeature.PREVENT_CHILD_ENTITIES]: PreventChildEntities;
+  readonly [ISCFeature.PREVENT_GRID_ENTITY_RESPAWN]: PreventGridEntityRespawn;
+  readonly [ISCFeature.RERUN_DETECTION]: RerunDetection;
+  readonly [ISCFeature.ROOM_CLEAR_FRAME]: RoomClearFrame;
+  readonly [ISCFeature.ROOM_HISTORY]: RoomHistory;
+  readonly [ISCFeature.RUN_IN_N_FRAMES]: RunInNFrames;
+  readonly [ISCFeature.RUN_NEXT_ROOM]: RunNextRoom;
+  readonly [ISCFeature.RUN_NEXT_RUN]: RunNextRun;
+  readonly [ISCFeature.SAVE_DATA_MANAGER]: SaveDataManager;
+  readonly [ISCFeature.SPAWN_ALT_ROCK_REWARDS]: SpawnRockAltRewards;
+  readonly [ISCFeature.STAGE_HISTORY]: StageHistory;
+  readonly [ISCFeature.START_AMBUSH]: StartAmbush;
+  readonly [ISCFeature.TAINTED_LAZARUS_PLAYERS]: TaintedLazarusPlayers;
+  readonly [ISCFeature.UNLOCK_ACHIEVEMENTS_DETECTION]: UnlockAchievementsDetection;
 }
 
+// eslint-disable-next-line unicorn/no-top-level-side-effects
 interfaceSatisfiesEnum<ISCFeatureToClass, ISCFeature>();
 
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types

package/src/functions/array.ts

@@ -83,37 +83,6 @@ export function arrayRemoveAllInPlace<T>(
   return removedOneOrMoreElements;
 }
 
-/**
- * Removes the specified element(s) from the array. If the specified element(s) are not found in the
- * array, this function will do nothing.
- *
- * This function is variadic, meaning that you can specify N arguments to remove N elements.
- *
- * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
- * function instead.
- *
- * @returns The removed elements. This will be an empty array if no elements were removed.
- */
-export function arrayRemoveInPlace<T>(
-  // eslint-disable-next-line complete/prefer-readonly-parameter-types
-  array: T[],
-  ...elementsToRemove: readonly T[]
-  // eslint-disable-next-line complete/no-mutable-return
-): T[] {
-  const removedElements: T[] = [];
-
-  for (const element of elementsToRemove) {
-    const index = array.indexOf(element);
-    if (index !== -1) {
-      const removedElement = array.splice(index, 1);
-      removedElements.push(...removedElement);
-    }
-  }
-
-  return removedElements;
-}
-
 /**
  * Shallow copies and removes the elements at the specified indexes from the array. Returns the
  * copied array. If the specified indexes are not found in the array, it will simply return a
@@ -164,8 +133,41 @@ export function arrayRemoveIndexInPlace<T>(
   const removedElements: T[] = [];
 
   for (let i = array.length - 1; i >= 0; i--) {
-    if (legalIndexesSet.has(i)) {
-      const removedElement = array.splice(i, 1);
+    if (!legalIndexesSet.has(i)) {
+      continue;
+    }
+
+    const removedElement = array.splice(i, 1);
+    removedElements.push(...removedElement);
+  }
+
+  return removedElements;
+}
+
+/**
+ * Removes the specified element(s) from the array. If the specified element(s) are not found in the
+ * array, this function will do nothing.
+ *
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ *
+ * If there is more than one matching element in the array, this function will only remove the first
+ * matching element. If you want to remove all of the elements, use the `arrayRemoveAllInPlace`
+ * function instead.
+ *
+ * @returns The removed elements. This will be an empty array if no elements were removed.
+ */
+export function arrayRemoveInPlace<T>(
+  // eslint-disable-next-line complete/prefer-readonly-parameter-types
+  array: T[],
+  ...elementsToRemove: readonly T[]
+  // eslint-disable-next-line complete/no-mutable-return
+): T[] {
+  const removedElements: T[] = [];
+
+  for (const element of elementsToRemove) {
+    const index = array.indexOf(element);
+    if (index !== -1) {
+      const removedElement = array.splice(index, 1);
       removedElements.push(...removedElement);
     }
   }
@@ -229,7 +231,7 @@ 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 complete/prefer-readonly-parameter-types
 export function emptyArray(array: unknown[]): void {
-  array.splice(0);
+  array.length = 0;
 }
 
 /**
@@ -306,33 +308,13 @@ export function getArrayCombinations<T>(
 
   // Finally, account for the empty array combination.
   if (includeEmptyArray) {
+    // eslint-disable-next-line unicorn/no-array-front-mutation
     all.unshift([]);
   }
 
   return all;
 }
 
-/** Mutates the `all` array in-place. */
-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) {
-    if (got.length > 0) {
-      all[all.length] = got;
-    }
-
-    return;
-  }
-
-  for (const [i, element] of src.entries()) {
-    addCombinations(n - 1, src.slice(i + 1), [...got, element], all);
-  }
-}
-
 /**
  * Helper function to get the duplicate elements in an array. Only one element for each value will
  * be returned. The elements will be sorted before they are returned.
@@ -684,3 +666,24 @@ export function swapArrayElements(
   array[i] = value2;
   array[j] = value1;
 }
+
+/** Mutates the `all` array in-place. */
+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) {
+    if (got.length > 0) {
+      all[all.length] = got;
+    }
+
+    return;
+  }
+
+  for (const [i, element] of src.entries()) {
+    addCombinations(n - 1, src.slice(i + 1), [...got, element], all);
+  }
+}

package/src/functions/arrayLua.ts

@@ -55,7 +55,7 @@ export function forEach<T>(
   array: readonly T[],
   func: (value: T, index: number, array: readonly T[]) => void,
 ): void {
-  array.forEach(func); // eslint-disable-line unicorn/no-array-for-each
+  array.forEach(func); // eslint-disable-line unicorn/no-for-each
 }
 
 // `includes` is not included since there is a normal array helper function of that name.

package/src/functions/bitSet128.ts

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

package/src/functions/bitwise.ts

@@ -48,6 +48,7 @@ export function convertDecimalToBinary(
 
   if (minLength !== undefined) {
     while (bits.length < minLength) {
+      // eslint-disable-next-line unicorn/no-array-front-mutation
       bits.unshift(0);
     }
   }