isaacscript-common 2.0.23 → 2.0.26

package/dist/constantsMax.d.ts

@@ -1,27 +1,103 @@
 import { Card, CollectibleType, PillColor, PillEffect, PlayerType, TrinketType } from "isaac-typescript-definitions";
+/** Equal to `Card.FOOL`. */
 export declare const FIRST_CARD = Card.FOOL;
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
+ */
 export declare const NUM_CARDS: number;
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
+ */
 export declare const MAX_CARD: Card;
+/** Calculated from the `Card` enum. `Card.NULL` is not included. */
 export declare const NUM_VANILLA_CARDS: number;
+/** Calculated from the `Card` enum. */
 export declare const MAX_VANILLA_CARD: Card;
+/** Equal to `CollectibleType.SAD_ONION`. */
 export declare const FIRST_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION;
-export declare const NUM_COLLECTIBLE_TYPES: number;
+/**
+ * Will change depending on how many modded collectibles there are.
+ *
+ * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles. We
+ * subtract one to account for `CollectibleType.NULL`.)
+ */
 export declare const MAX_COLLECTIBLE_TYPE: CollectibleType;
-export declare const NUM_VANILLA_COLLECTIBLE_TYPES: CollectibleType;
+/** Calculated from the `CollectibleType` enum. `CollectibleType.NULL` is not included. */
+export declare const NUM_VANILLA_COLLECTIBLE_TYPES: number;
+/**
+ * Calculated from the `CollectibleType` enum.
+ *
+ * Note that this cannot be calculated from the length of the enum, because unlike all of the other
+ * enums, the collectible types are not contiguous.
+ */
 export declare const MAX_VANILLA_COLLECTIBLE_TYPE: CollectibleType;
+/** Equal to `PillEffect.BAD_GAS`. */
 export declare const FIRST_PILL_EFFECT = PillEffect.BAD_GAS;
+/**
+ * Will change depending on how many modded pill effects there are.
+ *
+ * Equal to `itemConfig.GetPillEffects().Size - 1`. (We subtract one to account for
+ * `PillEffect.NULL`.)
+ */
 export declare const NUM_PILL_EFFECTS: number;
+/**
+ * Will change depending on how many modded pill effects there are.
+ *
+ * Equal to `itemConfig.GetPillEffects().Size - 1`. (We subtract one to account for
+ * `PillEffect.NULL`.)
+ */
 export declare const MAX_PILL_EFFECT: PillEffect;
+/**
+ * Calculated from the `PillEffect` enum.
+ *
+ * (There is no `PillEffect.NULL` in the custom enum, so we don't have to subtract one here.)
+ */
 export declare const NUM_VANILLA_PILL_EFFECTS: number;
+/** Calculated from the `PillEffect` enum. */
 export declare const MAX_VANILLA_PILL_EFFECT: PillEffect;
+/** Equal to `TrinketType.SWALLOWED_PENNY`. */
 export declare const FIRST_TRINKET_TYPE = TrinketType.SWALLOWED_PENNY;
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
+ * `TrinketType.NULL`.)
+ */
 export declare const NUM_TRINKET_TYPES: number;
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
+ * `TrinketType.NULL`.)
+ */
 export declare const MAX_TRINKET_TYPE: TrinketType;
+/** Calculated from the `TrinketType` enum. `TrinketType.NULL` is not included. */
 export declare const NUM_VANILLA_TRINKET_TYPES: number;
+/** Calculated from the `TrinketType` enum. */
 export declare const MAX_VANILLA_TRINKET_TYPE: TrinketType;
+/** Equal to `PlayerType.ISAAC`. */
 export declare const FIRST_CHARACTER = PlayerType.ISAAC;
+/** Calculated from the `PlayerType` enum. */
 export declare const MAX_VANILLA_CHARACTER: PlayerType;
+/** Equal to `PillColor.BLUE_BLUE`. */
 export declare const FIRST_PILL_COLOR = PillColor.BLUE_BLUE;
+/**
+ * Equal to `PillColor.WHITE_YELLOW`.
+ *
+ * Note that `PillColor.GOLD` is technically higher, but that is not considered for the purposes of
+ * this constant.
+ */
 export declare const MAX_NORMAL_PILL_COLOR = PillColor.WHITE_YELLOW;
+/** Equal to `PillColor.HORSE_BLUE_BLUE`. */
 export declare const FIRST_HORSE_PILL_COLOR = PillColor.HORSE_BLUE_BLUE;
+/**
+ * Equal to `PillColor.HORSE_WHITE_YELLOW`.
+ *
+ * Note that `PillColor.HORSE_GOLD` is technically higher, but that is not considered for the
+ * purposes of this constant.
+ */
 export declare const MAX_HORSE_PILL_COLOR = PillColor.HORSE_WHITE_YELLOW;

package/dist/constantsMax.lua

@@ -15,22 +15,21 @@ ____exports.FIRST_CARD = Card.FOOL
 ____exports.NUM_CARDS = itemConfig:GetCards().Size - 1
 ____exports.MAX_CARD = ____exports.NUM_CARDS
 ____exports.NUM_VANILLA_CARDS = getEnumLength(nil, Card) - 1
-____exports.MAX_VANILLA_CARD = ____exports.NUM_VANILLA_CARDS
+____exports.MAX_VANILLA_CARD = getLastEnumValue(nil, Card)
 ____exports.FIRST_COLLECTIBLE_TYPE = CollectibleType.SAD_ONION
-____exports.NUM_COLLECTIBLE_TYPES = itemConfig:GetCollectibles().Size - 1
-____exports.MAX_COLLECTIBLE_TYPE = ____exports.NUM_COLLECTIBLE_TYPES
-____exports.NUM_VANILLA_COLLECTIBLE_TYPES = getLastEnumValue(nil, CollectibleType)
-____exports.MAX_VANILLA_COLLECTIBLE_TYPE = ____exports.NUM_VANILLA_COLLECTIBLE_TYPES
+____exports.MAX_COLLECTIBLE_TYPE = itemConfig:GetCollectibles().Size - 1
+____exports.NUM_VANILLA_COLLECTIBLE_TYPES = getEnumLength(nil, CollectibleType) - 1
+____exports.MAX_VANILLA_COLLECTIBLE_TYPE = getLastEnumValue(nil, CollectibleType)
 ____exports.FIRST_PILL_EFFECT = PillEffect.BAD_GAS
 ____exports.NUM_PILL_EFFECTS = itemConfig:GetPillEffects().Size - 1
 ____exports.MAX_PILL_EFFECT = ____exports.NUM_PILL_EFFECTS
 ____exports.NUM_VANILLA_PILL_EFFECTS = getEnumLength(nil, PillEffect)
-____exports.MAX_VANILLA_PILL_EFFECT = ____exports.NUM_VANILLA_PILL_EFFECTS
+____exports.MAX_VANILLA_PILL_EFFECT = getLastEnumValue(nil, PillEffect)
 ____exports.FIRST_TRINKET_TYPE = TrinketType.SWALLOWED_PENNY
 ____exports.NUM_TRINKET_TYPES = itemConfig:GetTrinkets().Size - 1
 ____exports.MAX_TRINKET_TYPE = ____exports.NUM_TRINKET_TYPES
 ____exports.NUM_VANILLA_TRINKET_TYPES = getEnumLength(nil, TrinketType) - 1
-____exports.MAX_VANILLA_TRINKET_TYPE = ____exports.NUM_VANILLA_TRINKET_TYPES
+____exports.MAX_VANILLA_TRINKET_TYPE = getLastEnumValue(nil, TrinketType)
 ____exports.FIRST_CHARACTER = PlayerType.ISAAC
 ____exports.MAX_VANILLA_CHARACTER = getLastEnumValue(nil, PlayerType)
 ____exports.FIRST_PILL_COLOR = PillColor.BLUE_BLUE

package/dist/functions/collectibleCacheFlag.d.ts

@@ -1,4 +1,5 @@
 import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
+export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
 /**
  * Returns a set containing every collectible type with the given cache flag, including modded
  * collectibles.

package/dist/functions/collectibleCacheFlag.lua

@@ -5,22 +5,32 @@ local Set = ____lualib.Set
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
 local ____collectibles = require("functions.collectibles")
-local collectibleHasCacheFlag = ____collectibles.collectibleHasCacheFlag
 local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
 local ____enums = require("functions.enums")
 local getEnumValues = ____enums.getEnumValues
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
 local ____set = require("functions.set")
 local copySet = ____set.copySet
 local getSortedSetValues = ____set.getSortedSetValues
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
+function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return false
+    end
+    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
+end
 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 ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
-            if collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
+            if ____exports.collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
                 collectiblesSet:add(collectibleType)
             end
         end

package/dist/functions/collectibleSet.d.ts

@@ -1,3 +1,11 @@
 import { CollectibleType } from "isaac-typescript-definitions";
 /** Returns a set containing every valid collectible type in the game, including modded items. */
 export declare function getCollectibleSet(): Set<CollectibleType>;
+/**
+ * Helper function to get the number of valid collectibles that exist. (This is not simply equal to
+ * the highest collectible type, because collectible types are not contiguous.)
+ *
+ * Note that there is no corresponding `getTrinketsNum` function because trinket types are
+ * contiguous. Use the `NUM_TRINKET_TYPES` constant instead.
+ */
+export declare function getCollectiblesNum(): int;

package/dist/functions/collectibleSet.lua

@@ -23,4 +23,10 @@ function ____exports.getCollectibleSet(self)
     end
     return copySet(nil, COLLECTIBLE_SET)
 end
+function ____exports.getCollectiblesNum(self)
+    if COLLECTIBLE_SET.size == 0 then
+        initCollectibleSet(nil)
+    end
+    return COLLECTIBLE_SET.size
+end
 return ____exports

package/dist/functions/collectibles.d.ts

@@ -1,7 +1,6 @@
-import { CacheFlag, CollectiblePedestalType, CollectibleType, ItemConfigTag, ItemType, PickupPrice } from "isaac-typescript-definitions";
+import { CollectiblePedestalType, CollectibleType, ItemConfigTag, ItemType, PickupPrice } from "isaac-typescript-definitions";
 import { CollectibleIndex } from "../types/CollectibleIndex";
 export declare function clearCollectibleSprite(collectible: EntityPickup): void;
-export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
 /** Helper function to check if two collectible sprites have the same sprite sheet loaded. */
 export declare function collectibleSpriteEquals(sprite1: Sprite, sprite2: Sprite): boolean;
 /**

package/dist/functions/collectibles.lua

@@ -26,8 +26,6 @@ local ____singleUseActiveCollectibleTypesSet = require("sets.singleUseActiveColl
 local SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET = ____singleUseActiveCollectibleTypesSet.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET
 local ____entity = require("functions.entity")
 local getEntityID = ____entity.getEntityID
-local ____flag = require("functions.flag")
-local hasFlag = ____flag.hasFlag
 local ____pickupVariants = require("functions.pickupVariants")
 local isCollectible = ____pickupVariants.isCollectible
 local ____roomData = require("functions.roomData")
@@ -64,13 +62,6 @@ local questionMarkSprite = initQuestionMarkSprite(nil)
 function ____exports.clearCollectibleSprite(self, collectible)
     ____exports.setCollectibleSprite(nil, collectible, nil)
 end
-function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return false
-    end
-    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
-end
 function ____exports.collectibleSpriteEquals(self, sprite1, sprite2)
     local xStart = -1
     local xFinish = 1

package/dist/functions/pickupVariants.d.ts

@@ -7,7 +7,17 @@ export declare function isCoin(pickup: EntityPickup): pickup is EntityPickupCoin
 export declare function isKey(pickup: EntityPickup): pickup is EntityPickupKey;
 /** For PickupVariant.BOMB (40) */
 export declare function isBomb(pickup: EntityPickup): pickup is EntityPickupBomb;
+/** For PickupVariant.POOP (42) */
+export declare function isPoop(pickup: EntityPickup): pickup is EntityPickupPoop;
+/** For PickupVariant.POOP (42) */
+export declare function isSack(pickup: EntityPickup): pickup is EntityPickupSack;
+/** For PickupVariant.PILL (70) */
+export declare function isPill(pickup: EntityPickup): pickup is EntityPickupPill;
+/** For PickupVariant.LIL_BATTERY (90) */
+export declare function isBattery(pickup: EntityPickup): pickup is EntityPickupBattery;
 /** For PickupVariant.COLLECTIBLE (100) */
 export declare function isCollectible(pickup: EntityPickup): pickup is EntityPickupCollectible;
+/** For PickupVariant.TAROT_CARD (300) */
+export declare function isCardPickup(pickup: EntityPickup): pickup is EntityPickupCard;
 /** For PickupVariant.TRINKET (350) */
 export declare function isTrinket(pickup: EntityPickup): pickup is EntityPickupTrinket;

package/dist/functions/pickupVariants.lua

@@ -13,9 +13,24 @@ end
 function ____exports.isBomb(self, pickup)
     return pickup.Variant == PickupVariant.BOMB
 end
+function ____exports.isPoop(self, pickup)
+    return pickup.Variant == PickupVariant.POOP
+end
+function ____exports.isSack(self, pickup)
+    return pickup.Variant == PickupVariant.SACK
+end
+function ____exports.isPill(self, pickup)
+    return pickup.Variant == PickupVariant.PILL
+end
+function ____exports.isBattery(self, pickup)
+    return pickup.Variant == PickupVariant.LIL_BATTERY
+end
 function ____exports.isCollectible(self, pickup)
     return pickup.Variant == PickupVariant.COLLECTIBLE
 end
+function ____exports.isCardPickup(self, pickup)
+    return pickup.Variant == PickupVariant.TAROT_CARD
+end
 function ____exports.isTrinket(self, pickup)
     return pickup.Variant == PickupVariant.TRINKET
 end

package/dist/functions/spawnCollectible.d.ts

@@ -13,8 +13,9 @@ import { CollectibleType } from "isaac-typescript-definitions";
  *                collectible. Default is false.
  * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
  *                      Tainted Keeper. Default is false.
+ * @param spawner Optional.
  */
-export declare function spawnCollectible(collectibleType: CollectibleType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean): EntityPickup;
+export declare function spawnCollectible(collectibleType: CollectibleType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
 /**
  * Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
  * with `CollectibleType.NULL` will result in spawning a collectible with a random type from the

package/dist/functions/spawnCollectible.lua

@@ -3,6 +3,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____preventCollectibleRotate = require("features.preventCollectibleRotate")
 local preventCollectibleRotate = ____preventCollectibleRotate.preventCollectibleRotate
 local ____featuresInitialized = require("featuresInitialized")
@@ -18,7 +20,7 @@ local anyPlayerIs = ____player.anyPlayerIs
 local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
 local isRNG = ____rng.isRNG
-function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG, options, forceFreeItem)
+function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG, options, forceFreeItem, spawner)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
@@ -34,7 +36,9 @@ function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG
         PickupVariant.COLLECTIBLE,
         collectibleType,
         position,
-        seed
+        seed,
+        VectorZero,
+        spawner
     )
     if options then
         collectible.OptionsPickupIndex = 1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.0.23",
+  "version": "2.0.26",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.39"
+    "isaac-typescript-definitions": "^2.0.45"
   },
   "devDependencies": {
     "isaacscript-lint": "^1.0.157",