isaacscript-common 87.6.2 → 87.7.0

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.9"
+      "packageVersion": "7.52.10"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "87.6.2",
+  "version": "87.7.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -40,10 +40,10 @@
     "isaac-typescript-definitions": "42.2.1"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "7.52.9",
-    "complete-node": "7.4.3",
+    "@microsoft/api-extractor": "7.52.10",
+    "complete-node": "9.0.0",
     "eslint-plugin-sort-exports": "0.9.1",
-    "typescript-eslint": "8.38.0",
+    "typescript-eslint": "8.39.0",
     "typescript-to-lua": "1.31.4"
   }
 }

package/src/functions/array.ts

@@ -29,16 +29,14 @@ export function arrayEquals<T>(
  * array. If the specified element(s) are not found in the array, it will simply return a shallow
  * copy of the array.
  *
- * 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 remove all of them.
  *
- * 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 `arrayRemoveAll` function
- * instead.
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemove<T>(
   originalArray: readonly T[],
   ...elementsToRemove: readonly T[]
+  // eslint-disable-next-line complete/no-mutable-return
 ): T[] {
   const elementsToRemoveSet = new ReadonlySet(elementsToRemove);
 
@@ -52,27 +50,6 @@ export function arrayRemove<T>(
   return array;
 }
 
-/**
- * Shallow copies and removes the specified element(s) from the array. Returns the copied array. If
- * the specified element(s) are not found in the array, it will simply return a shallow copy of the
- * array.
- *
- * 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 remove every matching
- * element. If you want to only remove the first matching element, use the `arrayRemove` function
- * instead.
- */
-// eslint-disable-next-line complete/no-mutable-return
-export function arrayRemoveAll<T>(
-  originalArray: readonly T[],
-  ...elementsToRemove: readonly T[]
-): T[] {
-  const array = copyArray(originalArray);
-  arrayRemoveAllInPlace(array, ...elementsToRemove);
-  return array;
-}
-
 /**
  * Removes all of the specified element(s) from the array. If the specified element(s) are not found
  * in the array, this function will do nothing.
@@ -118,11 +95,11 @@ export function arrayRemoveAllInPlace<T>(
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-// eslint-disable-next-line complete/no-mutable-return
 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[] = [];
 
@@ -144,10 +121,10 @@ export function arrayRemoveInPlace<T>(
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemoveIndex<T>(
   originalArray: readonly T[],
   ...indexesToRemove: readonly int[]
+  // eslint-disable-next-line complete/no-mutable-return
 ): T[] {
   const indexesToRemoveSet = new ReadonlySet(indexesToRemove);
 
@@ -169,11 +146,11 @@ export function arrayRemoveIndex<T>(
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function arrayRemoveIndexInPlace<T>(
   // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   ...indexesToRemove: readonly int[]
+  // eslint-disable-next-line complete/no-mutable-return
 ): T[] {
   const legalIndexes = indexesToRemove.filter(
     (i) => i >= 0 && i < array.length,
@@ -266,11 +243,10 @@ export function emptyArray(array: unknown[]): void {
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function filterMap<OldT, NewT>(
   array: readonly OldT[],
   func: (element: OldT) => NewT | undefined,
-): NewT[] {
+): readonly NewT[] {
   const filteredArray: NewT[] = [];
 
   for (const element of array) {
@@ -647,10 +623,10 @@ 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 complete/no-mutable-return
 export function shuffleArray<T>(
   originalArray: readonly T[],
   seedOrRNG: Seed | RNG | undefined,
+  // eslint-disable-next-line complete/no-mutable-return
 ): T[] {
   const array = copyArray(originalArray);
   shuffleArrayInPlace(array, seedOrRNG);

package/src/functions/debugFunctions.ts

@@ -42,7 +42,6 @@ export function getTime(useSocketIfAvailable = true): int | float {
     }
 
     if (isLuaDebugEnabled()) {
-      // eslint-disable-next-line unicorn/prefer-module
       const [ok, requiredSocket] = pcall(require, "socket");
       if (ok) {
         const socket = requiredSocket as Socket;

package/src/functions/map.ts

@@ -101,10 +101,9 @@ export function mapSetHash<V>(
  *
  * Also see the `objectToReadonlyMap` function.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectToMap<K extends string | number | symbol, V>(
   object: Record<K, V>,
-): Map<K, V> {
+): ReadonlyMap<K, V> {
   const map = new Map<K, V>();
 
   for (const [key, value] of Object.entries(object)) {

package/src/functions/set.ts

@@ -26,8 +26,9 @@ export function addSetsToSet<T>(
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-// eslint-disable-next-line complete/no-mutable-return
-export function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T> {
+export function combineSets<T>(
+  ...sets: ReadonlyArray<ReadonlySet<T>>
+): ReadonlySet<T> {
   const newSet = new Set<T>();
   for (const set of sets) {
     for (const value of set) {
@@ -123,9 +124,9 @@ 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 complete/no-mutable-return
 export function getSortedSetValues<T extends number | string>(
   set: ReadonlySet<T>,
+  // eslint-disable-next-line complete/no-mutable-return
 ): T[] {
   const values = [...set];
 
@@ -167,9 +168,9 @@ export function objectKeysToReadonlySet<K extends string | number | symbol, V>(
  *
  * Also see the `objectKeysToReadonlySet` function.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectKeysToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
+  // eslint-disable-next-line complete/no-mutable-return
 ): Set<K> {
   const set = new Set<K>();
 
@@ -203,9 +204,9 @@ export function objectValuesToReadonlySet<
  *
  * Also see the `objectValuesToReadonlySet` function.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectValuesToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
+  // eslint-disable-next-line complete/no-mutable-return
 ): Set<V> {
   const set = new Set<V>();
 

package/src/functions/sort.ts

@@ -149,11 +149,11 @@ export function sortTwoDimensionalArray<T>(
  *
  * Under the hood, this uses the merge sort algorithm.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function stableSort<T>(
   // eslint-disable-next-line complete/prefer-readonly-parameter-types
   array: T[],
   sortFunc: (a: T, b: T) => -1 | 0 | 1 = sortNormal,
+  // eslint-disable-next-line complete/no-mutable-return
 ): T[] {
   // Base case: an array of zero or one elements is already sorted
   if (array.length <= 1) {

package/src/functions/utils.ts

@@ -1,3 +1,4 @@
+import { game } from "../core/cachedClasses";
 import { ReadonlySet } from "../types/ReadonlySet";
 import { getAllPlayers } from "./playerIndex";
 import { isFunction } from "./types";
@@ -155,7 +156,7 @@ export function isMultiplayer(): boolean {
 }
 
 /**
- * Helper function to check if the player is using Afterbirth+ or Repentance.
+ * Helper function to check if the player has the Repentance DLC installed.
  *
  * This function should always be used over the `REPENTANCE` constant, since the latter is not safe.
  *
@@ -181,6 +182,23 @@ export function isRepentance(): boolean {
   return isFunction(getAnimation);
 }
 
+/**
+ * Helper function to check if the player has the Repentance+ DLC installed.
+ *
+ * This function should always be used over the `REPENTANCE_PLUS` constant, since the latter is not
+ * safe.
+ *
+ * Specifically, this function checks for `Room:DamageGridWithSource` method:
+ * https://bindingofisaacrebirth.wiki.gg/wiki/The_Binding_of_Isaac:_Repentance%2B#Modding_Changes
+ */
+export function isRepentancePlus(): boolean {
+  const room = game.GetRoom();
+  const metatable = getmetatable(room) as LuaMap<string, unknown> | undefined;
+  assertDefined(metatable, "Failed to get the metatable of the room class.");
+  const damageGridWithSource = metatable.get("DamageGridWithSource");
+  return isFunction(damageGridWithSource);
+}
+
 /**
  * Helper function to check if the player is using REPENTOGON, an exe-hack which expands the modding
  * API.