isaacscript-common 4.8.1 → 4.9.1

package/enums/ModCallbackCustom.d.ts

@@ -706,7 +706,7 @@ export declare enum ModCallbackCustom {
      * what it was on the previous frame.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the player matches the `CollectibleType` provided.
+     * only fire if the collectible matches the `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleAdded(
@@ -721,7 +721,7 @@ export declare enum ModCallbackCustom {
      * what it was on the previous frame.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the player matches the `CollectibleType` provided.
+     * only fire if the collectible matches the `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleRemoved(

package/functions/array.d.ts

@@ -63,7 +63,6 @@ export declare function emptyArray<T>(array: T[]): void;
  * For example, if this function is provided an array containing 1, 2, and 3, then it will return an
  * array containing the following arrays:
  *
- * - []
  * - [1]
  * - [2]
  * - [3]
@@ -75,11 +74,12 @@ export declare function emptyArray<T>(array: T[]): void;
  * From: https://github.com/firstandthird/combinations/blob/master/index.js
  *
  * @param array The array to get the combinations of.
+ * @param includeEmptyArray Whether or not to include an empty array in the combinations.
  * @param min Optional. The minimum number of elements to include in each combination. Default is 1.
  * @param max Optional. The maximum number of elements to include in each combination. Default is
  *            the length of the array.
  */
-export declare function getArrayCombinations<T>(array: T[] | readonly T[], min?: int, max?: int): ReadonlyArray<readonly T[]>;
+export declare function getArrayCombinations<T>(array: T[] | readonly T[], includeEmptyArray: boolean, min?: int, max?: int): ReadonlyArray<readonly T[]>;
 /**
  * Helper function to get an array containing the indexes of an array.
  *

package/functions/array.lua

@@ -214,7 +214,6 @@ end
 -- For example, if this function is provided an array containing 1, 2, and 3, then it will return an
 -- array containing the following arrays:
 -- 
--- - []
 -- - [1]
 -- - [2]
 -- - [3]
@@ -226,10 +225,11 @@ end
 -- From: https://github.com/firstandthird/combinations/blob/master/index.js
 -- 
 -- @param array The array to get the combinations of.
+-- @param includeEmptyArray Whether or not to include an empty array in the combinations.
 -- @param min Optional. The minimum number of elements to include in each combination. Default is 1.
 -- @param max Optional. The maximum number of elements to include in each combination. Default is
 -- the length of the array.
-function ____exports.getArrayCombinations(self, array, min, max)
+function ____exports.getArrayCombinations(self, array, includeEmptyArray, min, max)
     if min == nil or min <= 0 then
         min = 1
     end
@@ -276,7 +276,9 @@ function ____exports.getArrayCombinations(self, array, min, max)
     if #array == max then
         all[#all + 1] = array
     end
-    __TS__ArrayUnshift(all, {})
+    if includeEmptyArray then
+        __TS__ArrayUnshift(all, {})
+    end
     return all
 end
 --- Helper function to get an array containing the indexes of an array.

package/functions/minimap.d.ts

@@ -1,4 +1,11 @@
 import { DisplayFlag } from "isaac-typescript-definitions";
+/**
+ * Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ */
+export declare function clearFloorDisplayFlags(): void;
 /**
  * Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
  * that is indexed by the room's safe grid index.

package/functions/minimap.lua

@@ -3,6 +3,8 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DisplayFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlagZero
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____roomData = require("functions.roomData")
@@ -18,6 +20,17 @@ function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags)
     local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
     roomDescriptor.DisplayFlags = displayFlags
 end
+--- Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
+-- 
+-- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+-- the changes will be immediately visible.
+function ____exports.clearFloorDisplayFlags(self)
+    local level = game:GetLevel()
+    for ____, room in ipairs(getRoomsInGrid(nil)) do
+        room.DisplayFlags = DisplayFlagZero
+    end
+    level:UpdateVisibility()
+end
 --- Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
 -- that is indexed by the room's safe grid index.
 function ____exports.getFloorDisplayFlags(self)

package/functions/random.d.ts

@@ -40,5 +40,8 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
  * @param max The upper bound for the random number (inclusive).
  * @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 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.
  */
-export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG): int;
+export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG, exceptions?: int[] | readonly int[]): int;

package/functions/random.lua

@@ -1,3 +1,6 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
@@ -54,10 +57,16 @@ end
 -- @param max The upper bound for the random number (inclusive).
 -- @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.getRandomInt(self, min, max, seedOrRNG)
+-- @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.
+function ____exports.getRandomInt(self, min, max, seedOrRNG, exceptions)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
+    if exceptions == nil then
+        exceptions = {}
+    end
     local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     if min > max then
         local oldMin = min
@@ -65,6 +74,13 @@ function ____exports.getRandomInt(self, min, max, seedOrRNG)
         min = oldMax
         max = oldMin
     end
-    return rng:RandomInt(max - min + 1) + min
+    local exceptionsSet = __TS__New(Set, exceptions)
+    local randomInt
+    repeat
+        do
+            randomInt = rng:RandomInt(max - min + 1) + min
+        end
+    until exceptionsSet:has(randomInt)
+    return randomInt
 end
 return ____exports

package/functions/set.d.ts

@@ -46,8 +46,11 @@ export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, see
  * - [1, 3]
  * - [2, 3]
  * - [1, 2, 3]
+ *
+ * @param set The set to get the combinations of.
+ * @param includeEmptyArray Whether or not to include an empty array in the combinations.
  */
-export declare function getSetCombinations<T>(set: Set<T> | ReadonlySet<T>): ReadonlyArray<ReadonlySet<T>>;
+export declare function getSetCombinations<T>(set: Set<T> | ReadonlySet<T>, includeEmptyArray: boolean): ReadonlyArray<ReadonlySet<T>>;
 /**
  * Helper function to get a sorted array based on the contents of a set.
  *

package/functions/set.lua

@@ -96,9 +96,12 @@ end
 -- - [1, 3]
 -- - [2, 3]
 -- - [1, 2, 3]
-function ____exports.getSetCombinations(self, set)
+-- 
+-- @param set The set to get the combinations of.
+-- @param includeEmptyArray Whether or not to include an empty array in the combinations.
+function ____exports.getSetCombinations(self, set, includeEmptyArray)
     local values = ____exports.getSortedSetValues(nil, set)
-    local combinations = getArrayCombinations(nil, values)
+    local combinations = getArrayCombinations(nil, values, includeEmptyArray)
     return __TS__ArrayMap(
         combinations,
         function(____, array) return __TS__New(Set, array) end

package/objects/oppositeDoorSlots.lua

@@ -6,8 +6,8 @@ ____exports.OPPOSITE_DOOR_SLOTS = {
     [DoorSlot.LEFT_0] = DoorSlot.RIGHT_0,
     [DoorSlot.UP_0] = DoorSlot.DOWN_0,
     [DoorSlot.RIGHT_0] = DoorSlot.LEFT_0,
-    [DoorSlot.LEFT_1] = DoorSlot.RIGHT_1,
     [DoorSlot.DOWN_0] = DoorSlot.UP_0,
+    [DoorSlot.LEFT_1] = DoorSlot.RIGHT_1,
     [DoorSlot.UP_1] = DoorSlot.DOWN_1,
     [DoorSlot.RIGHT_1] = DoorSlot.LEFT_1,
     [DoorSlot.DOWN_1] = DoorSlot.UP_1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.8.1",
+  "version": "4.9.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.15"
+    "isaac-typescript-definitions": "^3.0.17"
   }
 }