isaacscript-common 1.2.107 → 1.2.110

package/dist/callbacks/postPurchase.lua

@@ -2,11 +2,13 @@
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local Set = ____lualib.Set
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
-local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
-local hasSubscriptions, postUpdate, checkPickupsPurchased, getPlayerThatIsNoLongerHoldingAnItem, storePickupsInMap, storePlayersInMap, pickupAtIndexStillExists, v
+local hasSubscriptions, postUpdate, checkPickupsPurchased, getPlayerThatIsNoLongerHoldingAnItem, storePickupsInMap, storePlayersInMap, v
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____pickups = require("functions.pickups")
@@ -14,6 +16,10 @@ local getPickups = ____pickups.getPickups
 local ____player = require("functions.player")
 local getPlayerIndex = ____player.getPlayerIndex
 local getPlayers = ____player.getPlayers
+local ____DefaultMap = require("types.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____PickupDescription = require("types.PickupDescription")
+local getPickupDescription = ____PickupDescription.getPickupDescription
 local ____postPurchase = require("callbacks.subscriptions.postPurchase")
 local postPurchaseFire = ____postPurchase.postPurchaseFire
 local postPurchaseHasSubscriptions = ____postPurchase.postPurchaseHasSubscriptions
@@ -25,65 +31,64 @@ function postUpdate(self)
         return
     end
     local pickups = getPickups(nil)
+    local pickupsWithPrice = __TS__ArrayFilter(
+        pickups,
+        function(____, pickup) return pickup:Exists() and pickup.Price ~= 0 end
+    )
     local players = getPlayers(nil)
-    checkPickupsPurchased(nil, pickups, players)
-    storePickupsInMap(nil, pickups)
+    checkPickupsPurchased(nil, pickupsWithPrice, players)
+    storePickupsInMap(nil, pickupsWithPrice)
     storePlayersInMap(nil, players)
 end
-function checkPickupsPurchased(self, pickups, players)
+function checkPickupsPurchased(self, nonCollectiblesWithPrice, players)
+    local pickupIndexes = __TS__ArrayMap(
+        nonCollectiblesWithPrice,
+        function(____, pickup) return pickup.Index end
+    )
+    local pickupIndexSet = __TS__New(Set, pickupIndexes)
     for ____, ____value in __TS__Iterator(v.room.pickupMap:entries()) do
         local index = ____value[1]
         local pickupDescription = ____value[2]
         do
-            if pickupAtIndexStillExists(nil, index, pickups) then
-                goto __continue7
+            if pickupIndexSet:has(index) then
+                goto __continue9
             end
-            v.room.pickupMap:delete(index)
             local player = getPlayerThatIsNoLongerHoldingAnItem(nil, players)
             if player ~= nil then
                 postPurchaseFire(nil, player, pickupDescription)
             end
         end
-        ::__continue7::
+        ::__continue9::
     end
 end
 function getPlayerThatIsNoLongerHoldingAnItem(self, players)
     return __TS__ArrayFind(
         players,
         function(____, player)
-            local playerHoldingItem = player:IsHoldingItem()
+            local playerHoldingItemNow = player:IsHoldingItem()
             local playerIndex = getPlayerIndex(nil, player)
-            local playerHoldingItemLastFrame = v.room.playerHoldingItemLastFrameMap:get(playerIndex)
-            return playerHoldingItemLastFrame == false and playerHoldingItem
+            local playerHoldingItemOnLastFrame = v.room.playersHoldingItemOnLastFrameMap:getAndSetDefault(playerIndex)
+            return not playerHoldingItemOnLastFrame and playerHoldingItemNow
         end
     )
 end
-function storePickupsInMap(self, pickups)
-    local pickupsWithPrice = __TS__ArrayFilter(
-        pickups,
-        function(____, pickup) return pickup.Price ~= 0 end
-    )
-    for ____, pickup in ipairs(pickupsWithPrice) do
-        v.room.pickupMap:set(pickup.Index, {variant = pickup.Variant, subType = pickup.SubType, price = pickup.Price, initSeed = pickup.InitSeed})
+function storePickupsInMap(self, nonCollectiblesWithPrice)
+    v.room.pickupMap:clear()
+    for ____, pickup in ipairs(nonCollectiblesWithPrice) do
+        local pickupDescription = getPickupDescription(nil, pickup)
+        v.room.pickupMap:set(pickup.Index, pickupDescription)
     end
 end
 function storePlayersInMap(self, players)
     for ____, player in ipairs(players) do
         local playerIndex = getPlayerIndex(nil, player)
         local holdingItem = player:IsHoldingItem()
-        v.room.playerHoldingItemLastFrameMap:set(playerIndex, holdingItem)
+        v.room.playersHoldingItemOnLastFrameMap:set(playerIndex, holdingItem)
     end
 end
-function pickupAtIndexStillExists(self, index, pickups)
-    local pickupAtIndex = __TS__ArrayFind(
-        pickups,
-        function(____, pickup) return pickup.Index end
-    )
-    return pickupAtIndex ~= nil and pickupAtIndex:Exists()
-end
 v = {room = {
     pickupMap = __TS__New(Map),
-    playerHoldingItemLastFrameMap = __TS__New(Map)
+    playersHoldingItemOnLastFrameMap = __TS__New(DefaultMap, false)
 }}
 function ____exports.postPurchaseCallbackInit(self, mod)
     saveDataManager(nil, "postPurchase", v, hasSubscriptions)

package/dist/features/getCollectibleItemPoolType.lua

@@ -6,6 +6,8 @@ local ____exports = {}
 local postPickupInitCollectible, v
 local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
 local ____rooms = require("functions.rooms")
 local getRoomItemPoolType = ____rooms.getRoomItemPoolType
 local ____exports = require("features.saveDataManager.exports")
@@ -31,7 +33,8 @@ function ____exports.getCollectibleItemPoolType(self, collectible)
         error(msg)
     end
     if collectible.Type ~= EntityType.ENTITY_PICKUP or collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
-        error((((("The \"getCollectibleItemPoolType()\" function was given a non-collectible: " .. tostring(collectible.Type)) .. ".") .. tostring(collectible.Variant)) .. ".") .. tostring(collectible.SubType))
+        local entityID = getEntityID(nil, collectible)
+        error("The \"getCollectibleItemPoolType()\" function was given a non-collectible: " .. entityID)
     end
     local ptrHash = GetPtrHash(collectible)
     local itemPoolType = v.run.collectibleItemPoolTypeMap:get(ptrHash)

package/dist/functions/collectibles.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
+import { CollectiblePedestalType } from "../types/CollectiblePedestalType";
 export declare function collectibleHasTag(collectibleType: CollectibleType | int, tag: ItemConfigTag): boolean;
+export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 export declare function collectibleHasCacheFlag(collectibleType: CollectibleType | int, cacheFlag: CacheFlag): boolean;
 /**
  * Helper function to get the in-game description for a collectible. Returns "Unknown" if the
@@ -47,6 +49,7 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  * ```
  */
 export declare function getCollectibleName(collectibleType: CollectibleType | int): string;
+export declare function getCollectiblePedestalType(collectible: EntityPickup): CollectiblePedestalType;
 /** Helper function to get all of the collectible entities in the room. */
 export declare function getCollectibles(matchingSubType?: number): EntityPickup[];
 export declare function getMaxCollectibleType(): int;
@@ -55,7 +58,7 @@ export declare function getMaxCollectibleType(): int;
  * glitched items once a player has TMTRAINER. However, glitched items can also "naturally" appear
  * in secret rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
  */
-export declare function isGlitchedCollectible(entity: Entity): boolean;
+export declare function isGlitchedCollectible(pickup: EntityPickup): boolean;
 /**
  * Returns true if the item type in the item config is equal to `ItemType.ITEM_PASSIVE` or
  * `ItemType.ITEM_FAMILIAR`.
@@ -98,24 +101,24 @@ export declare function setCollectiblesRerolledForItemTracker(): void;
 export declare function setCollectibleBlind(collectible: EntityPickup): void;
 /**
  * Helper function to remove the collectible from a collectible pedestal and make it appear as if a
- * player has already taken the item. This is accomplished by setting its sprite to an empty/missing
- * PNG file.
+ * player has already taken the item. This is accomplished by changing the sub-type to
+ * `CollectibleType.COLLECTIBLE_NULL` and then setting the sprite to an empty/missing PNG file.
  *
- * For more information, see the documentation for the "emptySprite" helper function.
+ * For more information, see the documentation for the "clearSprite" helper function.
  */
 export declare function setCollectibleEmpty(collectible: EntityPickup): void;
 /**
  * Helper function to change the sprite of a collectible pedestal entity.
  *
  * For more information about removing the collectible sprite, see the documentation for the
- * "emptySprite" helper function.
+ * "clearSprite" helper function.
  *
  * @param collectible The collectible whose sprite you want to modify.
- * @param pngPath Optional. Equal to the spritesheet path to load (e.g.
- * "gfx/items/collectibles/collectibles_001_thesadonion.png"). If not specified, will remove the
- * sprite, making it appear like the collectible has already been taken by the player.
+ * @param pngPath Equal to either the spritesheet path to load (e.g.
+ * "gfx/items/collectibles/collectibles_001_thesadonion.png") or undefined. If undefined, the sprite
+ * will be removed, making it appear like the collectible has already been taken by the player.
  */
-export declare function setCollectibleSprite(collectible: EntityPickup, pngPath?: string): 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.

package/dist/functions/collectibles.lua

@@ -38,6 +38,9 @@ function ____exports.collectibleHasTag(self, collectibleType, tag)
     end
     return itemConfigItem:HasTags(tag)
 end
+function ____exports.clearCollectibleSprite(self, collectible)
+    ____exports.setCollectibleSprite(nil, collectible, nil)
+end
 function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
     local itemConfig = Isaac.GetItemConfig()
     local itemConfigItem = itemConfig:GetCollectible(collectibleType)
@@ -135,6 +138,13 @@ function ____exports.getCollectibleName(self, collectibleType)
     end
     return itemConfigItem.Name
 end
+function ____exports.getCollectiblePedestalType(self, collectible)
+    if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
+        error("You cannot get the pedestal type for pickups of variant: " .. tostring(collectible.Variant))
+    end
+    local sprite = collectible:GetSprite()
+    return sprite:GetOverlayFrame()
+end
 function ____exports.getCollectibles(self, matchingSubType)
     if matchingSubType == nil then
         matchingSubType = -1
@@ -145,8 +155,8 @@ function ____exports.getMaxCollectibleType(self)
     local itemConfig = Isaac.GetItemConfig()
     return itemConfig:GetCollectibles().Size - 1
 end
-function ____exports.isGlitchedCollectible(self, entity)
-    return entity.Type == EntityType.ENTITY_PICKUP and entity.Variant == PickupVariant.PICKUP_COLLECTIBLE and entity.SubType > GLITCHED_ITEM_THRESHOLD
+function ____exports.isGlitchedCollectible(self, pickup)
+    return pickup.Variant == PickupVariant.PICKUP_COLLECTIBLE and pickup.SubType > GLITCHED_ITEM_THRESHOLD
 end
 function ____exports.isPassiveCollectible(self, collectibleType)
     local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
@@ -185,7 +195,7 @@ function ____exports.setCollectibleEmpty(self, collectible)
         error("You cannot set a collectible to be empty for pickups of variant: " .. tostring(collectible.Variant))
     end
     collectible.SubType = CollectibleType.COLLECTIBLE_NULL
-    ____exports.setCollectibleSprite(nil, collectible)
+    ____exports.clearCollectibleSprite(nil, collectible)
 end
 function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then

package/dist/functions/entity.d.ts

@@ -53,6 +53,8 @@ export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities:
  * returned. False by default. Will only be taken into account if `matchingEntityType` is specified.
  */
 export declare function getEntities(matchingEntityType?: EntityType | int, matchingVariant?: number, matchingSubType?: number, ignoreFriendly?: boolean): Entity[];
+/** Helper function to return a string containing an entity's type, variant, and sub-type. */
+export declare function getEntityID(entity: Entity): string;
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *

package/dist/functions/entity.lua

@@ -88,6 +88,9 @@ function ____exports.getEntities(self, matchingEntityType, matchingVariant, matc
     end
     return Isaac.FindByType(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
 end
+function ____exports.getEntityID(self, entity)
+    return (((tostring(entity.Type) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType)
+end
 function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01

package/dist/functions/spawnCollectible.d.ts

@@ -13,3 +13,12 @@
  * Tainted Keeper. False by default.
  */
 export declare function spawnCollectible(collectibleType: CollectibleType | int, position: Vector, seed?: number, options?: boolean, forceFreeItem?: boolean): EntityPickup;
+/**
+ * Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
+ * with `CollectibleType.COLLECTIBLE_NULL` will result in spawning a collectible with a random type
+ * from the current room's item pool.
+ *
+ * Instead, this function arbitrarily spawns a collectible with
+ * `CollectibleType.COLLECTIBLE_SAD_ONION`, and then converts it to an empty pedestal afterward.
+ */
+export declare function spawnEmptyCollectible(position: Vector, seed?: number): void;

package/dist/functions/spawnCollectible.lua

@@ -6,6 +6,7 @@ local ____featuresInitialized = require("featuresInitialized")
 local areFeaturesInitialized = ____featuresInitialized.areFeaturesInitialized
 local ____collectibles = require("functions.collectibles")
 local isQuestCollectible = ____collectibles.isQuestCollectible
+local setCollectibleEmpty = ____collectibles.setCollectibleEmpty
 local ____player = require("functions.player")
 local anyPlayerIs = ____player.anyPlayerIs
 function ____exports.spawnCollectible(self, collectibleType, position, seed, options, forceFreeItem)
@@ -46,4 +47,18 @@ function ____exports.spawnCollectible(self, collectibleType, position, seed, opt
     end
     return collectible
 end
+function ____exports.spawnEmptyCollectible(self, position, seed)
+    if seed == nil then
+        seed = Random()
+    end
+    local collectible = ____exports.spawnCollectible(
+        nil,
+        CollectibleType.COLLECTIBLE_SAD_ONION,
+        position,
+        seed,
+        false,
+        true
+    )
+    setCollectibleEmpty(nil, collectible)
+end
 return ____exports

package/dist/index.lua

@@ -674,6 +674,14 @@ do
         end
     end
 end
+do
+    local ____export = require("types.PickupDescription")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("types.PillEffectClass")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/types/CollectiblePedestalType.d.ts

@@ -0,0 +1,38 @@
+/** Corresponds to the overlay frame number in "005.100_collectible.anm2". */
+export declare enum CollectiblePedestalType {
+    /**
+     * Used for e.g. shop collectibles. In the "005.100_collectible.anm2" file, this is represented by
+     * the final frame.
+     */
+    NONE = -1,
+    /** The normal grey pedestal. */
+    NORMAL = 0,
+    /** From SlotVariant.FORTUNE_TELLING_MACHINE (3) */
+    FORTUNE_TELLING_MACHINE = 1,
+    /** From SlotVariant.BLOOD_DONATION_MACHINE (2) */
+    BLOOD_DONATION_MACHINE = 2,
+    /** From SlotVariant.SLOT_MACHINE (1) */
+    SLOT_MACHINE = 3,
+    /** From PickupVariant.LOCKEDCHEST (60) */
+    LOCKEDCHEST = 4,
+    /** From PickupVariant.PICKUP_REDCHEST (360) */
+    REDCHEST = 5,
+    /** From PickupVariant.PICKUP_BOMBCHEST (51) */
+    BOMBCHEST = 6,
+    /** From PickupVariant.PICKUP_SPIKEDCHEST (52) */
+    SPIKEDCHEST = 7,
+    /** From PickupVariant.PICKUP_ETERNALCHEST (53) */
+    ETERNALCHEST = 8,
+    /** From SlotVariant.MOMS_DRESSING_TABLE (12) */
+    MOMS_DRESSING_TABLE = 9,
+    /** From PickupVariant.PICKUP_CHEST (50) */
+    CHEST = 10,
+    /** From PickupVariant.PICKUP_MOMSCHEST (390) */
+    MOMSCHEST = 11,
+    /** From PickupVariant.PICKUP_OLDCHEST (55) */
+    OLDCHEST = 12,
+    /** From PickupVariant.PICKUP_WOODENCHEST (56) */
+    WOODENCHEST = 13,
+    /** From PickupVariant.PICKUP_MEGACHEST (57) */
+    MEGACHEST = 14
+}

package/dist/types/CollectiblePedestalType.lua

@@ -0,0 +1,36 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+____exports.CollectiblePedestalType = CollectiblePedestalType or ({})
+____exports.CollectiblePedestalType.NONE = -1
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.NONE] = "NONE"
+____exports.CollectiblePedestalType.NORMAL = 0
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.NORMAL] = "NORMAL"
+____exports.CollectiblePedestalType.FORTUNE_TELLING_MACHINE = 1
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.FORTUNE_TELLING_MACHINE] = "FORTUNE_TELLING_MACHINE"
+____exports.CollectiblePedestalType.BLOOD_DONATION_MACHINE = 2
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.BLOOD_DONATION_MACHINE] = "BLOOD_DONATION_MACHINE"
+____exports.CollectiblePedestalType.SLOT_MACHINE = 3
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.SLOT_MACHINE] = "SLOT_MACHINE"
+____exports.CollectiblePedestalType.LOCKEDCHEST = 4
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.LOCKEDCHEST] = "LOCKEDCHEST"
+____exports.CollectiblePedestalType.REDCHEST = 5
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.REDCHEST] = "REDCHEST"
+____exports.CollectiblePedestalType.BOMBCHEST = 6
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.BOMBCHEST] = "BOMBCHEST"
+____exports.CollectiblePedestalType.SPIKEDCHEST = 7
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.SPIKEDCHEST] = "SPIKEDCHEST"
+____exports.CollectiblePedestalType.ETERNALCHEST = 8
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.ETERNALCHEST] = "ETERNALCHEST"
+____exports.CollectiblePedestalType.MOMS_DRESSING_TABLE = 9
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.MOMS_DRESSING_TABLE] = "MOMS_DRESSING_TABLE"
+____exports.CollectiblePedestalType.CHEST = 10
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.CHEST] = "CHEST"
+____exports.CollectiblePedestalType.MOMSCHEST = 11
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.MOMSCHEST] = "MOMSCHEST"
+____exports.CollectiblePedestalType.OLDCHEST = 12
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.OLDCHEST] = "OLDCHEST"
+____exports.CollectiblePedestalType.WOODENCHEST = 13
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.WOODENCHEST] = "WOODENCHEST"
+____exports.CollectiblePedestalType.MEGACHEST = 14
+____exports.CollectiblePedestalType[____exports.CollectiblePedestalType.MEGACHEST] = "MEGACHEST"
+return ____exports

package/dist/types/PickupDescription.d.ts

@@ -2,6 +2,9 @@
 export interface PickupDescription {
     variant: PickupVariant | int;
     subType: int;
+    position: Vector;
+    velocity: Vector;
     price: int;
     initSeed: int;
 }
+export declare function getPickupDescription(pickup: EntityPickup): PickupDescription;

package/dist/types/PickupDescription.lua

@@ -1,3 +1,13 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+function ____exports.getPickupDescription(self, pickup)
+    return {
+        variant = pickup.Variant,
+        subType = pickup.SubType,
+        position = pickup.Position,
+        velocity = pickup.Velocity,
+        price = pickup.Price,
+        initSeed = pickup.InitSeed
+    }
+end
 return ____exports

package/package.json

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