isaacscript-common 1.2.5 → 1.2.6

package/dist/functions/array.d.ts

@@ -61,6 +61,15 @@ export declare function arrayRemoveInPlace<T>(array: T[], ...elements: T[]): boo
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
 export declare function getRandomArrayElement<T>(array: T[], seed?: number, exceptions?: T[]): T;
+/**
+ * Helper function to get a random element from the provided array. Once the random element is
+ * decided, it is then removed from the array (in-place).
+ *
+ * @param array The array to get an element from.
+ * @param seed Optional. The seed used to select the random element. `Random()` by default.
+ * @param exceptions Optional. An array of elements to skip over if selected.
+ */
+export declare function getRandomArrayElementAndRemove<T>(array: T[], seed?: number, exceptions?: T[]): T;
 export declare function getRandomArrayIndex<T>(array: T[], seed?: number): int;
 /**
  * Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a

package/dist/functions/array.lua

@@ -145,6 +145,17 @@ function ____exports.getRandomArrayElement(self, array, seed, exceptions)
     local randomIndex = ____exports.getRandomArrayIndex(nil, arrayWithoutExceptions, seed)
     return arrayWithoutExceptions[randomIndex + 1]
 end
+function ____exports.getRandomArrayElementAndRemove(self, array, seed, exceptions)
+    if seed == nil then
+        seed = Random()
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    local randomArrayElement = ____exports.getRandomArrayElement(nil, array, seed, exceptions)
+    ____exports.arrayRemoveInPlace(nil, array, randomArrayElement)
+    return randomArrayElement
+end
 function ____exports.isArray(self, ____table)
     local metatable = getmetatable(____table)
     if metatable ~= nil then

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",