isaacscript-common 87.6.2 → 87.8.0

package/dist/functions/weighted.lua

@@ -34,7 +34,7 @@ function ____exports.getRandomIndexFromWeightedArray(self, weightedArray, seedOr
     for ____, ____value in __TS__Iterator(__TS__ArrayEntries(weightedArray)) do
         local i = ____value[1]
         local tuple = ____value[2]
-        local _element, weight = table.unpack(tuple)
+        local _element, weight = table.unpack(tuple, 1, 2)
         weightAccumulator = weightAccumulator + weight
         if weightAccumulator >= randomWeight then
             return i

package/dist/index.rollup.d.ts

@@ -1085,26 +1085,11 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly 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 only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAll` function
- * instead.
- */
-export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
-
-/**
- * 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.
+ * If there is more than one matching element in the array, this function will remove all of them.
  *
  * 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.
  */
-export declare function arrayRemoveAll<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
 
 /**
  * Removes all of the specified element(s) from the array. If the specified element(s) are not found
@@ -1705,7 +1690,7 @@ export declare function combineArrays<T>(...arrays: ReadonlyArray<readonly T[]>)
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T>;
+export declare function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): ReadonlySet<T>;
 
 /**
  * Helper type to validate that a union of interfaces with a field of `type` that is based on an
@@ -4625,7 +4610,7 @@ export declare function filter<T>(array: readonly T[], func: (value: T, index: n
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): NewT[];
+export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): readonly NewT[];
 
 /**
  * Helper function for non-TypeScript users to find an element in an array.
@@ -10051,7 +10036,7 @@ export declare function isRedKeyRoom(roomGridIndex: int): boolean;
 export declare function isReflectionRender(): 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.
  *
@@ -10075,6 +10060,17 @@ export declare function isRepentanceBoss(bossID: BossID): boolean;
  */
 export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
 
+/**
+ * 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 declare function isRepentancePlus(): boolean;
+
 /**
  * Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
  * `StageType.REPENTANCE_B`.
@@ -15127,7 +15123,7 @@ export declare function objectKeysToSet<K extends string | number | symbol, V>(o
  *
  * Also see the `objectToReadonlyMap` function.
  */
-export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): Map<K, V>;
+export declare function objectToMap<K extends string | number | symbol, V>(object: Record<K, V>): ReadonlyMap<K, V>;
 
 /**
  * Helper function to convert an object to a read-only map.