isaacscript-common 2.0.10 → 2.0.11

package/dist/features/deployJSONRoom.lua

@@ -40,8 +40,6 @@ local ____jsonRoom = require("functions.jsonRoom")
 local getRandomJSONRoom = ____jsonRoom.getRandomJSONRoom
 local ____log = require("functions.log")
 local log = ____log.log
-local ____math = require("functions.math")
-local erange = ____math.erange
 local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
 local isRNG = ____rng.isRNG
@@ -55,6 +53,8 @@ local setRoomCleared = ____rooms.setRoomCleared
 local setRoomUncleared = ____rooms.setRoomUncleared
 local ____spawnCollectible = require("functions.spawnCollectible")
 local spawnCollectible = ____spawnCollectible.spawnCollectible
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 function postNewRoom(self)

package/dist/functions/array.lua

@@ -11,8 +11,6 @@ local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__ArrayReduce = ____lualib.__TS__ArrayReduce
 local ____exports = {}
-local ____math = require("functions.math")
-local erange = ____math.erange
 local ____random = require("functions.random")
 local getRandomInt = ____random.getRandomInt
 local ____rng = require("functions.rng")
@@ -20,6 +18,7 @@ local getRandomSeed = ____rng.getRandomSeed
 local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
 local ____utils = require("functions.utils")
+local erange = ____utils.erange
 local ____repeat = ____utils["repeat"]
 function ____exports.getRandomArrayIndex(self, array, seedOrRNG)
     if seedOrRNG == nil then

package/dist/functions/cards.lua

@@ -23,13 +23,13 @@ local CARD_TYPES = ____cardTypes.CARD_TYPES
 local DEFAULT_CARD_TYPE = ____cardTypes.DEFAULT_CARD_TYPE
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
 local ____set = require("functions.set")
 local addSetsToSet = ____set.addSetsToSet
 local getRandomSetElement = ____set.getRandomSetElement
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 function initCardObjects(self)
     for ____, cardType in ipairs(getEnumValues(nil, ItemConfigCardType)) do
         CARD_TYPE_TO_CARDS_MAP:set(

package/dist/functions/collectibleCacheFlag.lua

@@ -11,12 +11,11 @@ local ____collectibles = require("functions.collectibles")
 local collectibleHasCacheFlag = ____collectibles.collectibleHasCacheFlag
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local getSortedSetValues = ____set.getSortedSetValues
 local ____utils = require("functions.utils")
+local irange = ____utils.irange
 local ____repeat = ____utils["repeat"]
 local CACHE_FLAG_TO_COLLECTIBLES_MAP = __TS__New(Map)
 local function initCacheFlagMap(self)

package/dist/functions/collectibleSet.lua

@@ -6,10 +6,10 @@ local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____constantsMax = require("constantsMax")
 local MAX_COLLECTIBLE_TYPE = ____constantsMax.MAX_COLLECTIBLE_TYPE
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____set = require("functions.set")
 local copySet = ____set.copySet
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 local COLLECTIBLE_SET = __TS__New(Set)
 local function initCollectibleSet(self)
     for ____, collectibleType in ipairs(irange(nil, 1, MAX_COLLECTIBLE_TYPE)) do

package/dist/functions/collectibleTag.lua

@@ -14,12 +14,12 @@ local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
 local getFlagName = ____flag.getFlagName
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____player = require("functions.player")
 local getPlayerCollectibleCount = ____player.getPlayerCollectibleCount
 local ____set = require("functions.set")
 local copySet = ____set.copySet
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 function ____exports.collectibleHasTag(self, collectibleType, tag)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     if itemConfigItem == nil then

package/dist/functions/collectibles.d.ts

@@ -160,8 +160,8 @@ export declare function setCollectibleEmpty(collectible: EntityPickup): void;
  */
 export declare function setCollectibleSprite(collectible: EntityPickup, pngPath: string | undefined): void;
 /**
- * Helper function to change the collectible on a pedestal. Simply updating the SubType property is
- * not sufficient because the sprite will not change.
+ * Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
+ * is not sufficient because the sprite will not change.
  */
 export declare function setCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType | int): void;
 /**

package/dist/functions/enums.d.ts

@@ -54,6 +54,15 @@ export declare function getEnumLength<T>(transpiledEnum: T): int;
  */
 export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
 export declare function getLastEnumValue<T>(transpiledEnum: T): T[keyof T];
+/**
+ * Helper function to get a random element from the provided enum.
+ *
+ * @param transpiledEnum The enum to get an element 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 elements to skip over if selected.
+ */
+export declare function getRandomEnumElement<T>(transpiledEnum: T, seedOrRNG?: Seed | RNG, exceptions?: Array<T[keyof T]> | ReadonlyArray<T[keyof T]>): T[keyof T];
 /**
  * Helper function to check every value of a custom enum for -1. This is helpful as a run-time check
  * because many methods of the Isaac class return -1 if they fail.

package/dist/functions/enums.lua

@@ -2,6 +2,10 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local ____exports = {}
+local ____array = require("functions.array")
+local getRandomArrayElement = ____array.getRandomArrayElement
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
 function ____exports.getEnumEntries(self, transpiledEnum)
     local enumEntries = {}
     for key, value in pairs(transpiledEnum) do
@@ -59,6 +63,16 @@ function ____exports.getLastEnumValue(self, transpiledEnum)
     end
     return lastElement
 end
+function ____exports.getRandomEnumElement(self, transpiledEnum, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
+    return getRandomArrayElement(nil, enumValues, seedOrRNG, exceptions)
+end
 function ____exports.validateCustomEnum(self, transpiledEnumName, transpiledEnum)
     for ____, ____value in ipairs(____exports.getEnumEntries(nil, transpiledEnum)) do
         local key = ____value[1]

package/dist/functions/gridEntity.lua

@@ -26,12 +26,13 @@ local ____roomShapeToTopLeftWallGridIndexMap = require("maps.roomShapeToTopLeftW
 local DEFAULT_TOP_LEFT_WALL_GRID_INDEX = ____roomShapeToTopLeftWallGridIndexMap.DEFAULT_TOP_LEFT_WALL_GRID_INDEX
 local ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = ____roomShapeToTopLeftWallGridIndexMap.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP
 local ____math = require("functions.math")
-local erange = ____math.erange
 local isCircleIntersectingRectangle = ____math.isCircleIntersectingRectangle
 local ____rooms = require("functions.rooms")
 local roomUpdateSafe = ____rooms.roomUpdateSafe
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
 local ____vector = require("functions.vector")
 local isVector = ____vector.isVector
 function getAllGridEntities(self)

package/dist/functions/input.lua

@@ -10,12 +10,12 @@ local ControllerIndex = ____isaac_2Dtypescript_2Ddefinitions.ControllerIndex
 local Keyboard = ____isaac_2Dtypescript_2Ddefinitions.Keyboard
 local ____constants = require("constants")
 local MAX_NUM_INPUTS = ____constants.MAX_NUM_INPUTS
-local ____math = require("functions.math")
-local erange = ____math.erange
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____string = require("functions.string")
 local trimPrefix = ____string.trimPrefix
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
 local MODIFIER_KEYS = {
     Keyboard.LEFT_SHIFT,
     Keyboard.LEFT_CONTROL,

package/dist/functions/math.d.ts

@@ -1,13 +1,4 @@
 import { Direction } from "isaac-typescript-definitions";
-/**
- * Helper function to return an array with the elements from start to end. It is inclusive at the
- * start and exclusive at the end. (The "e" stands for exclusive.)
- *
- * For example, `erange(1, 3)` will return `[1, 2]`.
- *
- * If only one argument is specified, then it will assume that the start is 0.
- */
-export declare function erange(start: int, end?: int): int[];
 export declare function getAngleDifference(angle1: float, angle2: float): float;
 /**
  * Helper function to get an array of equidistant points on the circumference around a circle.
@@ -29,15 +20,6 @@ export declare function getCircleDiscretizedPoints(centerPos: Vector, radius: fl
  * the rectangle.
  */
 export declare function inRectangle(position: Vector, topLeft: Vector, bottomRight: Vector): boolean;
-/**
- * Helper function to return an array with the elements from start to end, inclusive. (The "i"
- * stands for inclusive.)
- *
- * For example, `irange(1, 3)` will return `[1, 2, 3]`.
- *
- * If only one argument is specified, then it will assume that the start is 0.
- */
-export declare function irange(start: int, end?: int): int[];
 /**
  * From: https://www.geeksforgeeks.org/check-if-any-point-overlaps-the-given-circle-and-rectangle/
  */

package/dist/functions/math.lua

@@ -3,21 +3,6 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____direction = require("functions.direction")
 local directionToVector = ____direction.directionToVector
-function ____exports.erange(self, start, ____end)
-    if ____end == nil then
-        ____end = start
-        start = 0
-    end
-    local array = {}
-    do
-        local i = start
-        while i < ____end do
-            array[#array + 1] = i
-            i = i + 1
-        end
-    end
-    return array
-end
 function ____exports.getAngleDifference(self, angle1, angle2)
     local subtractedAngle = angle1 - angle2
     return (subtractedAngle + 180) % 360 - 180
@@ -51,21 +36,6 @@ end
 function ____exports.inRectangle(self, position, topLeft, bottomRight)
     return position.X >= topLeft.X and position.X <= bottomRight.X and position.Y >= topLeft.Y and position.Y <= bottomRight.Y
 end
-function ____exports.irange(self, start, ____end)
-    if ____end == nil then
-        ____end = start
-        start = 0
-    end
-    local array = {}
-    do
-        local i = start
-        while i <= ____end do
-            array[#array + 1] = i
-            i = i + 1
-        end
-    end
-    return array
-end
 function ____exports.isCircleIntersectingRectangle(self, circleCenter, circleRadius, rectangleTopLeft, rectangleBottomRight)
     local nearestX = math.max(
         rectangleTopLeft.X,

package/dist/functions/rooms.lua

@@ -39,8 +39,6 @@ local ____entity = require("functions.entity")
 local getEntities = ____entity.getEntities
 local ____flag = require("functions.flag")
 local hasFlag = ____flag.hasFlag
-local ____math = require("functions.math")
-local erange = ____math.erange
 local ____positionVelocity = require("functions.positionVelocity")
 local getEntityPositions = ____positionVelocity.getEntityPositions
 local getEntityVelocities = ____positionVelocity.getEntityVelocities
@@ -58,6 +56,8 @@ local getRoomStageID = ____roomData.getRoomStageID
 local getRoomSubType = ____roomData.getRoomSubType
 local ____roomShape = require("functions.roomShape")
 local getGridIndexDelta = ____roomShape.getGridIndexDelta
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
         includeExtraDimensionalRooms = false

package/dist/functions/sprite.lua

@@ -4,8 +4,8 @@ local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
 local VectorZero = ____constants.VectorZero
 local ____kColor = require("functions.kColor")
 local kColorEquals = ____kColor.kColorEquals
-local ____math = require("functions.math")
-local erange = ____math.erange
+local ____utils = require("functions.utils")
+local erange = ____utils.erange
 function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
     local kColor1 = sprite1:GetTexel(position, VectorZero, 1, layerID)
     local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)

package/dist/functions/trinketCacheFlag.lua

@@ -11,12 +11,12 @@ local ____constantsMax = require("constantsMax")
 local MAX_TRINKET_TYPE = ____constantsMax.MAX_TRINKET_TYPE
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____trinkets = require("functions.trinkets")
 local trinketHasCacheFlag = ____trinkets.trinketHasCacheFlag
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 function initCacheFlagMap(self)
     for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
         local trinketsSet = __TS__New(Set)

package/dist/functions/trinketSet.lua

@@ -6,10 +6,10 @@ local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
 local ____constantsMax = require("constantsMax")
 local MAX_TRINKET_TYPE = ____constantsMax.MAX_TRINKET_TYPE
-local ____math = require("functions.math")
-local irange = ____math.irange
 local ____set = require("functions.set")
 local copySet = ____set.copySet
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 local TRINKET_SET = __TS__New(Set)
 local function initTrinketSet(self)
     for ____, trinketType in ipairs(irange(nil, 1, MAX_TRINKET_TYPE)) do

package/dist/functions/utils.d.ts

@@ -35,6 +35,15 @@
  * ```
  */
 export declare const ensureAllCases: (obj: never) => never;
+/**
+ * Helper function to return an array with the elements from start to end. It is inclusive at the
+ * start and exclusive at the end. (The "e" stands for exclusive.)
+ *
+ * For example, `erange(1, 3)` will return `[1, 2]`.
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ */
+export declare function erange(start: int, end?: int): int[];
 /**
  * Helper function to log what is happening in functions that recursively move through nested data
  * structures.
@@ -46,6 +55,15 @@ export declare function getTraversalDescription(key: unknown, traversalDescripti
  * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
  */
 export declare function hexToKColor(hexString: string, alpha: float): KColor;
+/**
+ * Helper function to return an array with the elements from start to end, inclusive. (The "i"
+ * stands for inclusive.)
+ *
+ * For example, `irange(1, 3)` will return `[1, 2, 3]`.
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ */
+export declare function irange(start: int, end?: int): int[];
 /**
  * Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
  * be a non-zero value in reflections.

package/dist/functions/utils.lua

@@ -8,6 +8,21 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local HEX_STRING_LENGTH = 6
 ____exports.ensureAllCases = function(____, obj) return obj end
+function ____exports.erange(self, start, ____end)
+    if ____end == nil then
+        ____end = start
+        start = 0
+    end
+    local array = {}
+    do
+        local i = start
+        while i < ____end do
+            array[#array + 1] = i
+            i = i + 1
+        end
+    end
+    return array
+end
 function ____exports.getTraversalDescription(self, key, traversalDescription)
     if traversalDescription ~= "" then
         traversalDescription = traversalDescription .. " --> "
@@ -38,6 +53,21 @@ function ____exports.hexToKColor(self, hexString, alpha)
     local base = 255
     return KColor(R / base, G / base, B / base, alpha)
 end
+function ____exports.irange(self, start, ____end)
+    if ____end == nil then
+        ____end = start
+        start = 0
+    end
+    local array = {}
+    do
+        local i = start
+        while i <= ____end do
+            array[#array + 1] = i
+            i = i + 1
+        end
+    end
+    return array
+end
 function ____exports.isReflectionRender(self)
     local room = game:GetRoom()
     local renderMode = room:GetRenderMode()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,10 +25,10 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.13"
+    "isaac-typescript-definitions": "^2.0.14"
   },
   "devDependencies": {
-    "isaacscript-lint": "^1.0.142",
+    "isaacscript-lint": "^1.0.145",
     "isaacscript-spell": "^1.0.3",
     "isaacscript-tsconfig": "^1.1.16",
     "ts-node": "^10.7.0",