isaacscript-common 5.0.2 → 5.0.3

package/functions/array.d.ts

@@ -117,8 +117,10 @@ export declare function getRandomArrayElementAndRemove<T>(array: T[], seedOrRNG?
  * @param array The array to get the index from.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param exceptions Optional. An array of indexes that will be skipped over when getting the random
+ *                   index. Default is an empty array.
  */
-export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOrRNG?: Seed | RNG): int;
+export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOrRNG?: Seed | RNG, exceptions?: int[] | readonly int[]): int;
 /**
  * Initializes an array with all elements containing the specified default value.
  *

package/functions/array.lua

@@ -32,14 +32,25 @@ local ____repeat = ____utils["repeat"]
 -- @param array The array to get the index from.
 -- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
 -- `RNG.Next` method will be called. Default is `getRandomSeed()`.
-function ____exports.getRandomArrayIndex(self, array, seedOrRNG)
+-- @param exceptions Optional. An array of indexes that will be skipped over when getting the random
+-- index. Default is an empty array.
+function ____exports.getRandomArrayIndex(self, array, seedOrRNG, exceptions)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
+    if exceptions == nil then
+        exceptions = {}
+    end
     if #array == 0 then
         error("Failed to get a random array index since the provided array is empty.")
     end
-    return getRandomInt(nil, 0, #array - 1, seedOrRNG)
+    return getRandomInt(
+        nil,
+        0,
+        #array - 1,
+        seedOrRNG,
+        exceptions
+    )
 end
 --- Shuffles the provided array in-place using the Fisher-Yates algorithm.
 -- 

package/functions/random.d.ts

@@ -42,6 +42,7 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param exceptions Optional. An array of elements that will be skipped over when getting the
  *                   random integer. For example, a min of 1, a max of 4, and an exceptions array of
- *                   `[2]` would cause the function to return either 1, 3, or 4.
+ *                   `[2]` would cause the function to return either 1, 3, or 4. Default is an empty
+ *                   array.
  */
 export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG, exceptions?: int[] | readonly int[]): int;

package/functions/random.lua

@@ -59,7 +59,8 @@ end
 -- `RNG.Next` method will be called. Default is `getRandomSeed()`.
 -- @param exceptions Optional. An array of elements that will be skipped over when getting the
 -- random integer. For example, a min of 1, a max of 4, and an exceptions array of
--- `[2]` would cause the function to return either 1, 3, or 4.
+-- `[2]` would cause the function to return either 1, 3, or 4. Default is an empty
+-- array.
 function ____exports.getRandomInt(self, min, max, seedOrRNG, exceptions)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
@@ -80,7 +81,7 @@ function ____exports.getRandomInt(self, min, max, seedOrRNG, exceptions)
         do
             randomInt = rng:RandomInt(max - min + 1) + min
         end
-    until exceptionsSet:has(randomInt)
+    until not exceptionsSet:has(randomInt)
     return randomInt
 end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "5.0.2",
+  "version": "5.0.3",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",