isaacscript-common 2.0.21 → 2.0.22

package/dist/functions/cards.d.ts

@@ -1,4 +1,6 @@
 import { Card, ItemConfigCardType } from "isaac-typescript-definitions";
+/** Helper function to get an array with every valid card sub-type. This includes modded cards. */
+export declare function getAllCards(): Card[];
 /**
  * Helper function to get a card description from a Card enum value.
  *

package/dist/functions/cards.lua

@@ -38,8 +38,7 @@ function initCardObjects(self)
             __TS__New(Set)
         )
     end
-    for ____, cardInt in ipairs(irange(nil, FIRST_CARD, MAX_CARD)) do
-        local card = cardInt
+    for ____, card in ipairs(____exports.getAllCards(nil)) do
         local cardType = ____exports.getCardType(nil, card)
         local cardTypeSet = CARD_TYPE_TO_CARDS_MAP:get(cardType)
         if cardTypeSet == nil then
@@ -56,6 +55,9 @@ function initCardObjects(self)
     )
     addSetsToSet(nil, CARD_SET, cards)
 end
+function ____exports.getAllCards(self)
+    return irange(nil, FIRST_CARD, MAX_CARD)
+end
 function ____exports.getCardType(self, card)
     local cardType = CARD_TYPES[card]
     return cardType == nil and DEFAULT_CARD_TYPE or cardType

package/dist/functions/collectibleCacheFlag.lua

@@ -5,25 +5,21 @@ local Set = ____lualib.Set
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
-local ____constantsMax = require("constantsMax")
-local FIRST_COLLECTIBLE_TYPE = ____constantsMax.FIRST_COLLECTIBLE_TYPE
-local MAX_COLLECTIBLE_TYPE = ____constantsMax.MAX_COLLECTIBLE_TYPE
 local ____collectibles = require("functions.collectibles")
 local collectibleHasCacheFlag = ____collectibles.collectibleHasCacheFlag
+local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 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)
     for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
         local collectiblesSet = __TS__New(Set)
-        for ____, collectibleTypeInt in ipairs(irange(nil, FIRST_COLLECTIBLE_TYPE, MAX_COLLECTIBLE_TYPE)) do
-            local collectibleType = collectibleTypeInt
+        for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
             if collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
                 collectiblesSet:add(collectibleType)
             end

package/dist/functions/collectibleSet.lua

@@ -4,17 +4,13 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
-local ____constantsMax = require("constantsMax")
-local FIRST_COLLECTIBLE_TYPE = ____constantsMax.FIRST_COLLECTIBLE_TYPE
-local MAX_COLLECTIBLE_TYPE = ____constantsMax.MAX_COLLECTIBLE_TYPE
+local ____collectibles = require("functions.collectibles")
+local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
 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 ____, collectibleTypeInt in ipairs(irange(nil, FIRST_COLLECTIBLE_TYPE, MAX_COLLECTIBLE_TYPE)) do
-        local collectibleType = collectibleTypeInt
+    for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
         local itemConfigItem = itemConfig:GetCollectible(collectibleType)
         if itemConfigItem ~= nil then
             COLLECTIBLE_SET:add(collectibleType)

package/dist/functions/collectibleTag.lua

@@ -8,9 +8,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
-local ____constantsMax = require("constantsMax")
-local FIRST_COLLECTIBLE_TYPE = ____constantsMax.FIRST_COLLECTIBLE_TYPE
-local MAX_COLLECTIBLE_TYPE = ____constantsMax.MAX_COLLECTIBLE_TYPE
+local ____collectibles = require("functions.collectibles")
+local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____flag = require("functions.flag")
@@ -19,8 +18,6 @@ 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
@@ -36,8 +33,7 @@ local function initTagMap(self)
             __TS__New(Set)
         )
     end
-    for ____, collectibleTypeInt in ipairs(irange(nil, FIRST_COLLECTIBLE_TYPE, MAX_COLLECTIBLE_TYPE)) do
-        local collectibleType = collectibleTypeInt
+    for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
         for ____, itemConfigTag in ipairs(getEnumValues(nil, ItemConfigTag)) do
             do
                 if not ____exports.collectibleHasTag(nil, collectibleType, itemConfigTag) then

package/dist/functions/collectibles.d.ts

@@ -102,6 +102,15 @@ export declare function getCollectibleQuality(collectibleType: CollectibleType):
  * ```
  */
 export declare function getCollectibleTags(collectibleType: CollectibleType): BitFlags<ItemConfigTag>;
+/**
+ * Helper function to get an array that represents the range from the first collectible type to the
+ * last collectible type. This will include integers that do not represent any valid collectible
+ * types.
+ *
+ * This function is only useful when building collectible type objects. For most purposes, you
+ * should use the `getCollectibleSet` helper function instead.
+ */
+export declare function getCollectibleTypeRange(): CollectibleType[];
 /** Returns true if the item type in the item config is equal to `ItemType.ITEM_ACTIVE`. */
 export declare function isActiveCollectible(collectibleType: CollectibleType): boolean;
 /** Returns true if the collectible has a red question mark sprite. */

package/dist/functions/collectibles.lua

@@ -13,6 +13,9 @@ local game = ____cachedClasses.game
 local itemConfig = ____cachedClasses.itemConfig
 local ____constants = require("constants")
 local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local ____constantsMax = require("constantsMax")
+local FIRST_COLLECTIBLE_TYPE = ____constantsMax.FIRST_COLLECTIBLE_TYPE
+local MAX_COLLECTIBLE_TYPE = ____constantsMax.MAX_COLLECTIBLE_TYPE
 local ____collectibleDescriptionMap = require("maps.collectibleDescriptionMap")
 local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
 local DEFAULT_COLLECTIBLE_DESCRIPTION = ____collectibleDescriptionMap.DEFAULT_COLLECTIBLE_DESCRIPTION
@@ -32,6 +35,8 @@ local getRoomListIndex = ____roomData.getRoomListIndex
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
 local spriteEquals = ____sprite.spriteEquals
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 function initQuestionMarkSprite(self)
     local sprite = Sprite()
     sprite:Load("gfx/005.100_collectible.anm2", false)
@@ -188,6 +193,9 @@ function ____exports.getCollectibleTags(self, collectibleType)
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
     return itemConfigItem == nil and ItemConfigTagZero or itemConfigItem.Tags
 end
+function ____exports.getCollectibleTypeRange(self)
+    return irange(nil, FIRST_COLLECTIBLE_TYPE, MAX_COLLECTIBLE_TYPE)
+end
 function ____exports.isActiveCollectible(self, collectibleType)
     local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
     return itemType == ItemType.ACTIVE

package/dist/functions/rooms.d.ts

@@ -5,6 +5,10 @@ import { BossID, Dimension, Direction, DoorSlot, ItemPoolType, MinibossID, RoomS
  * not forget to set the `LeaveDoor` property and to prevent crashing on invalid room grid indexes.
  */
 export declare function changeRoom(roomGridIndex: int): void;
+/**
+ * Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
+ */
+export declare function getAllDimensions(): Dimension[];
 export declare function getAllRoomGridIndexes(): int[];
 /**
  * Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,

package/dist/functions/rooms.lua

@@ -114,6 +114,9 @@ function ____exports.changeRoom(self, roomGridIndex)
     level.LeaveDoor = DoorSlot.NO_DOOR_SLOT
     game:ChangeRoom(roomGridIndex)
 end
+function ____exports.getAllDimensions(self)
+    return erange(nil, NUM_DIMENSIONS)
+end
 function ____exports.getAllRoomGridIndexes(self)
     local rooms = ____exports.getRooms(nil)
     return __TS__ArrayMap(
@@ -129,8 +132,7 @@ function ____exports.getCurrentDimension(self)
     local startingRoomGridIndex = level:GetStartingRoomIndex()
     local startingRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, Dimension.CURRENT)
     local startingRoomHash = GetPtrHash(startingRoomDescription)
-    for ____, dimensionInt in ipairs(erange(nil, NUM_DIMENSIONS)) do
-        local dimension = dimensionInt
+    for ____, dimension in ipairs(____exports.getAllDimensions(nil)) do
         local dimensionRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, dimension)
         local dimensionRoomHash = GetPtrHash(dimensionRoomDescription)
         if dimensionRoomHash == startingRoomHash then
@@ -347,12 +349,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue67
+                goto __continue68
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue67::
+        ::__continue68::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/trinketCacheFlag.lua

@@ -7,22 +7,17 @@ local ____exports = {}
 local initCacheFlagMap, CACHE_FLAG_TO_TRINKETS_MAP
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
-local ____constantsMax = require("constantsMax")
-local FIRST_TRINKET_TYPE = ____constantsMax.FIRST_TRINKET_TYPE
-local MAX_TRINKET_TYPE = ____constantsMax.MAX_TRINKET_TYPE
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local ____trinkets = require("functions.trinkets")
+local getTrinketTypeRange = ____trinkets.getTrinketTypeRange
 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)
-        for ____, trinketTypeInt in ipairs(irange(nil, FIRST_TRINKET_TYPE, MAX_TRINKET_TYPE)) do
-            local trinketType = trinketTypeInt
+        for ____, trinketType in ipairs(getTrinketTypeRange(nil)) do
             if trinketHasCacheFlag(nil, trinketType, cacheFlag) then
                 trinketsSet:add(trinketType)
             end

package/dist/functions/trinketSet.lua

@@ -4,17 +4,13 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
-local ____constantsMax = require("constantsMax")
-local FIRST_TRINKET_TYPE = ____constantsMax.FIRST_TRINKET_TYPE
-local MAX_TRINKET_TYPE = ____constantsMax.MAX_TRINKET_TYPE
 local ____set = require("functions.set")
 local copySet = ____set.copySet
-local ____utils = require("functions.utils")
-local irange = ____utils.irange
+local ____trinkets = require("functions.trinkets")
+local getTrinketTypeRange = ____trinkets.getTrinketTypeRange
 local TRINKET_SET = __TS__New(Set)
 local function initTrinketSet(self)
-    for ____, trinketTypeInt in ipairs(irange(nil, FIRST_TRINKET_TYPE, MAX_TRINKET_TYPE)) do
-        local trinketType = trinketTypeInt
+    for ____, trinketType in ipairs(getTrinketTypeRange(nil)) do
         local itemConfigTrinket = itemConfig:GetTrinket(trinketType)
         if itemConfigTrinket ~= nil then
             TRINKET_SET:add(trinketType)

package/dist/functions/trinkets.d.ts

@@ -38,6 +38,14 @@ export declare function getTrinketDescription(trinketType: TrinketType): string;
  * ```
  */
 export declare function getTrinketName(trinketType: TrinketType): string;
+/**
+ * Helper function to get an array that represents the range from the first trinket type to the last
+ * trinket type. This will include integers that do not represent any valid trinket types.
+ *
+ * This function is only useful when building trinket type objects. For most purposes, you should
+ * use the `getTrinketSet` helper function instead.
+ */
+export declare function getTrinketTypeRange(): TrinketType[];
 /**
  * Returns whether or not the player can hold an additional trinket, beyond what they are currently
  * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.

package/dist/functions/trinkets.lua

@@ -5,6 +5,9 @@ local TrinketSlot = ____isaac_2Dtypescript_2Ddefinitions.TrinketSlot
 local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
 local ____cachedClasses = require("cachedClasses")
 local itemConfig = ____cachedClasses.itemConfig
+local ____constantsMax = require("constantsMax")
+local FIRST_TRINKET_TYPE = ____constantsMax.FIRST_TRINKET_TYPE
+local MAX_TRINKET_TYPE = ____constantsMax.MAX_TRINKET_TYPE
 local ____trinketDescriptionMap = require("maps.trinketDescriptionMap")
 local DEFAULT_TRINKET_DESCRIPTION = ____trinketDescriptionMap.DEFAULT_TRINKET_DESCRIPTION
 local TRINKET_DESCRIPTION_MAP = ____trinketDescriptionMap.TRINKET_DESCRIPTION_MAP
@@ -21,6 +24,8 @@ local ____player = require("functions.player")
 local isCharacter = ____player.isCharacter
 local ____sprite = require("functions.sprite")
 local clearSprite = ____sprite.clearSprite
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
 local GOLDEN_TRINKET_FLAG = 32767
 local GOLDEN_TRINKET_ADJUSTMENT = 32768
 local TRINKET_SPRITE_LAYER = 0
@@ -64,6 +69,9 @@ function ____exports.getTrinketName(self, trinketType)
     end
     return DEFAULT_TRINKET_NAME
 end
+function ____exports.getTrinketTypeRange(self)
+    return irange(nil, FIRST_TRINKET_TYPE, MAX_TRINKET_TYPE)
+end
 function ____exports.hasOpenTrinketSlot(self, player)
     if isCharacter(nil, player, PlayerType.THE_SOUL_B) then
         return false

package/package.json

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