isaacscript-common 1.0.495 → 1.0.499

package/dist/callbacks/subscriptions/preCustomRevive.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
 export declare type PreCustomReviveCallbackType = (player: EntityPlayer) => int | void;
-export declare function hasSubscriptions(): boolean;
-export declare function register(callback: PreCustomReviveCallbackType): void;
-export declare function fire(player: EntityPlayer): int | void;
+export declare function preCustomReviveHasSubscriptions(): boolean;
+export declare function preCustomReviveRegister(callback: PreCustomReviveCallbackType): void;
+export declare function preCustomReviveFire(player: EntityPlayer): int | void;

package/dist/callbacks/subscriptions/preCustomRevive.lua

@@ -2,13 +2,13 @@
 require("lualib_bundle");
 local ____exports = {}
 local subscriptions = {}
-function ____exports.hasSubscriptions(self)
+function ____exports.preCustomReviveHasSubscriptions(self)
     return #subscriptions > 0
 end
-function ____exports.register(self, callback)
+function ____exports.preCustomReviveRegister(self, callback)
     __TS__ArrayPush(subscriptions, {callback})
 end
-function ____exports.fire(self, player)
+function ____exports.preCustomReviveFire(self, player)
     local callback
     for ____, ____value in ipairs(subscriptions) do
         callback = ____value[1]

package/dist/callbacks/subscriptions/preItemPickup.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 import { PickingUpItem } from "../../types/PickingUpItem";
 export declare type PreItemPickupCallbackType = (player: EntityPlayer, pickingUpItem: PickingUpItem) => void;
-export declare function hasSubscriptions(): boolean;
-export declare function register(callback: PreItemPickupCallbackType, itemType?: ItemType, itemID?: int): void;
-export declare function fire(player: EntityPlayer, pickingUpItem: PickingUpItem): void;
+export declare function preItemPickupHasSubscriptions(): boolean;
+export declare function preItemPickupRegister(callback: PreItemPickupCallbackType, itemType?: ItemType, itemID?: int): void;
+export declare function preItemPickupFire(player: EntityPlayer, pickingUpItem: PickingUpItem): void;

package/dist/callbacks/subscriptions/preItemPickup.lua

@@ -2,13 +2,13 @@
 require("lualib_bundle");
 local ____exports = {}
 local subscriptions = {}
-function ____exports.hasSubscriptions(self)
+function ____exports.preItemPickupHasSubscriptions(self)
     return #subscriptions > 0
 end
-function ____exports.register(self, callback, itemType, itemID)
+function ____exports.preItemPickupRegister(self, callback, itemType, itemID)
     __TS__ArrayPush(subscriptions, {callback, itemType, itemID})
 end
-function ____exports.fire(self, player, pickingUpItem)
+function ____exports.preItemPickupFire(self, player, pickingUpItem)
     local itemID
     local itemType
     local callback

package/dist/constants.d.ts

@@ -4,6 +4,11 @@
  * For more info, see the documentation for the `getAzazelBrimstoneDistance()` function.
  */
 export declare const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
+/**
+ * The path to the png file for collectible items during Curse of the Blind, making them appear with
+ * a red question mark.
+ */
+export declare const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
 /** Bombs explode when their frame count is equal to this value. */
 export declare const BOMB_EXPLODE_FRAME = 45;
 export declare const CHARACTERS_WITH_AN_ACTIVE_ITEM: Set<PlayerType>;
@@ -17,6 +22,20 @@ export declare const CHARACTERS_WITH_NO_RED_HEARTS: Set<PlayerType>;
  * includes The Lost and Tainted Lost.
  */
 export declare const CHARACTERS_WITH_NO_SOUL_HEARTS: Set<PlayerType>;
+/**
+ * A collection of common colors that can be reused. Note that if you want to further modify these
+ * colors, you should copy them first with the `copyColor` function.
+ */
+export declare const COLORS: {
+    Black: Color;
+    Red: Color;
+    Green: Color;
+    Blue: Color;
+    Yellow: Color;
+    Pink: Color;
+    Cyan: Color;
+    White: Color;
+};
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.POOL_TREASURE;
 /** This is also the distance that a player spawns from the door that they enter a room from. */
 export declare const DISTANCE_OF_GRID_TILE = 40;
@@ -27,6 +46,13 @@ export declare const DOOR_HITBOX_DISTANCE = 11;
  * value.
  */
 export declare const EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45;
+/**
+ * A non-existent or completely transparent PNG file for use in clearing sprites. For more
+ * information, see the documentation for the `clearSprite()` helper function.
+ */
+export declare const EMPTY_PNG_PATH = "gfx/none.png";
+/** As of Repentance, the final stage is floor 13 (which is the Home floor). */
+export declare const FINAL_STAGE: number;
 /**
  * The random items that appear when the player has TMTRAINER are generated on the fly as they are
  * encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The

package/dist/constants.lua

@@ -2,6 +2,7 @@
 require("lualib_bundle");
 local ____exports = {}
 ____exports.AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125
+____exports.BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
 ____exports.BOMB_EXPLODE_FRAME = 45
 ____exports.CHARACTERS_WITH_AN_ACTIVE_ITEM = __TS__New(Set, {
     PlayerType.PLAYER_ISAAC,
@@ -33,10 +34,22 @@ ____exports.CHARACTERS_WITH_NO_SOUL_HEARTS = __TS__New(Set, {
     PlayerType.PLAYER_THELOST_B,
     PlayerType.PLAYER_KEEPER_B
 })
+____exports.COLORS = {
+    Black = Color(1, 1, 1),
+    Red = Color(1, 0, 0),
+    Green = Color(0, 1, 0),
+    Blue = Color(0, 0, 1),
+    Yellow = Color(1, 1, 0),
+    Pink = Color(1, 0, 1),
+    Cyan = Color(0, 1, 1),
+    White = Color(1, 1, 1)
+}
 ____exports.DEFAULT_ITEM_POOL_TYPE = ItemPoolType.POOL_TREASURE
 ____exports.DISTANCE_OF_GRID_TILE = 40
 ____exports.DOOR_HITBOX_DISTANCE = 11
 ____exports.EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45
+____exports.EMPTY_PNG_PATH = "gfx/none.png"
+____exports.FINAL_STAGE = LevelStage.NUM_STAGES - 1
 ____exports.FIRST_GLITCHED_COLLECTIBLE_TYPE = (1 << 32) - 1
 ____exports.GENESIS_ROOM_VARIANT = 1000
 ____exports.GENESIS_ROOM_SUBTYPE = 99

package/dist/features/getCollectibleItemPoolType.lua

@@ -1,35 +1,19 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
-local postPickupInitCollectible, preGetCollectible, v
+local postPickupInitCollectible, v
 local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
-local ____array = require("functions.array")
-local arrayEmpty = ____array.arrayEmpty
 local ____rooms = require("functions.rooms")
-local getRoomIndex = ____rooms.getRoomIndex
 local getRoomItemPoolType = ____rooms.getRoomItemPoolType
-local getRoomVisitedCount = ____rooms.getRoomVisitedCount
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 function postPickupInitCollectible(self, pickup)
-    local itemPoolType = __TS__ArrayShift(v.run.collectibleQueue)
-    if itemPoolType == nil then
-        return
-    end
+    local game = Game()
+    local itemPool = game:GetItemPool()
     local ptrHash = GetPtrHash(pickup)
-    v.run.collectibleItemPoolTypeMap:set(ptrHash, itemPoolType)
-end
-function preGetCollectible(self, itemPoolType, _decrease, _seed)
-    local roomIndex = getRoomIndex(nil)
-    local roomVisitedCount = getRoomVisitedCount(nil)
-    if roomIndex ~= v.run.currentRoomIndex or roomVisitedCount ~= v.run.currentRoomVisitedCount then
-        v.run.currentRoomIndex = roomIndex
-        v.run.currentRoomVisitedCount = roomVisitedCount
-        arrayEmpty(nil, v.run.collectibleQueue)
-        v.run.collectibleItemPoolTypeMap:clear()
-    end
-    __TS__ArrayPush(v.run.collectibleQueue, itemPoolType)
+    local lastItemPoolType = itemPool:GetLastPool()
+    v.run.collectibleItemPoolTypeMap:set(ptrHash, lastItemPoolType)
 end
 local FEATURE_NAME = "get collectible item pool type"
 local initialized = false
@@ -43,7 +27,6 @@ function ____exports.getCollectibleItemPoolTypeInit(self, mod)
     initialized = true
     saveDataManager(nil, "getCollectibleItemPoolType", v)
     mod:AddCallback(ModCallbacks.MC_POST_PICKUP_INIT, postPickupInitCollectible, PickupVariant.PICKUP_COLLECTIBLE)
-    mod:AddCallback(ModCallbacks.MC_PRE_GET_COLLECTIBLE, preGetCollectible)
 end
 function ____exports.getCollectibleItemPoolType(self, collectible)
     if not initialized then

package/dist/functions/collectibles.d.ts

@@ -56,6 +56,12 @@ export declare function isGlitchedCollectible(entity: Entity): boolean;
  */
 export declare function isPassiveCollectible(collectibleType: CollectibleType | int): boolean;
 export declare function isQuestCollectible(collectibleType: CollectibleType | int): boolean;
+/**
+ * Helper function to see if a particular collectible will disappear from the player's inventory
+ * upon use. Note that this will not work will modded items, as there is no way to dynamically know
+ * if a modded item will disappear.
+ */
+export declare function isSingleUseCollectible(collectibleType: CollectibleType | int): boolean;
 /**
  * Helper function to remove all of the collectibles in the room.
  *
@@ -78,7 +84,26 @@ export declare function removeCollectiblePickupDelay(collectible: EntityPickup):
  */
 export declare function removeCollectibleFromItemTracker(collectibleType: CollectibleType | int): void;
 export declare function setCollectibleBlind(collectible: EntityPickup): void;
-export declare function setCollectibleSprite(collectible: EntityPickup, pngPath: string): 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.
+ *
+ * For more information, see the documentation for the "EMPTY_PNG_FILENAME" constant.
+ */
+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
+ * "EMPTY_PNG_FILENAME" constant.
+ *
+ * @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.
+ */
+export declare function setCollectibleSprite(collectible: EntityPickup, pngPath?: string): 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

@@ -1,23 +1,32 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
-local COLLECTIBLE_SPRITE_LAYER
+local COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER
+local ____constants = require("constants")
+local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES = ____constants.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES
 local ____collectibleDescriptionMap = require("maps.collectibleDescriptionMap")
 local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
 local ____collectibleNameMap = require("maps.collectibleNameMap")
 local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
 local ____entity = require("functions.entity")
 local removeAllPickups = ____entity.removeAllPickups
+local ____sprite = require("functions.sprite")
+local clearSprite = ____sprite.clearSprite
 function ____exports.setCollectibleSprite(self, collectible, pngPath)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error("You cannot set a collectible sprite for pickups of variant: " .. tostring(collectible.Variant))
     end
     local sprite = collectible:GetSprite()
-    sprite:ReplaceSpritesheet(COLLECTIBLE_SPRITE_LAYER, pngPath)
-    sprite:LoadGraphics()
+    if pngPath == nil then
+        clearSprite(nil, sprite, COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER)
+    else
+        sprite:ReplaceSpritesheet(COLLECTIBLE_SPRITE_LAYER, pngPath)
+        sprite:LoadGraphics()
+    end
 end
 COLLECTIBLE_SPRITE_LAYER = 1
-local BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
+COLLECTIBLE_SHADOW_LAYER = 4
 local GLITCHED_ITEM_THRESHOLD = 4000000000
 function ____exports.collectibleHasTag(self, collectibleType, tag)
     local itemConfig = Isaac.GetItemConfig()
@@ -136,6 +145,9 @@ end
 function ____exports.isQuestCollectible(self, collectibleType)
     return ____exports.collectibleHasTag(nil, collectibleType, 32768)
 end
+function ____exports.isSingleUseCollectible(self, collectibleType)
+    return SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES:has(collectibleType)
+end
 function ____exports.removeAllCollectibles(self, collectibleType, cap)
     removeAllPickups(nil, PickupVariant.PICKUP_COLLECTIBLE, collectibleType, cap)
 end
@@ -155,6 +167,13 @@ function ____exports.setCollectibleBlind(self, collectible)
     end
     ____exports.setCollectibleSprite(nil, collectible, BLIND_ITEM_PNG_PATH)
 end
+function ____exports.setCollectibleEmpty(self, collectible)
+    if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
+        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)
+end
 function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
     if collectible.Variant ~= PickupVariant.PICKUP_COLLECTIBLE then
         error("You cannot set a collectible sub type for pickups of variant: " .. tostring(collectible.Variant))

package/dist/functions/gridEntity.d.ts

@@ -78,10 +78,9 @@ export declare function removeAllMatchingGridEntities(...gridEntityType: GridEnt
 export declare function removeGridEntity(gridEntity: GridEntity, updateRoom?: boolean): void;
 /**
  * Helper function to make a grid entity invisible. This is accomplished by setting its sprite to
- * "gfx/none.png" (a non-existent PNG file).
+ * an empty/missing PNG file.
  *
- * Using this function will cause spurious errors in the "log.txt file". If you want to remove them,
- * create a transparent 1 pixel PNG file in your resources folder at "gfx/none.png".
+ * For more information, see the documentation for the "EMPTY_PNG_FILENAME" constant.
  */
 export declare function setGridEntityInvisible(gridEntity: GridEntity): void;
 export declare function spawnGiantPoop(topLeftGridIndex: int): void;

package/dist/functions/gridEntity.lua

@@ -1,6 +1,8 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 require("lualib_bundle");
 local ____exports = {}
+local ____constants = require("constants")
+local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
 local ____gridEntityXMLMap = require("maps.gridEntityXMLMap")
 local GRID_ENTITY_XML_MAP = ____gridEntityXMLMap.GRID_ENTITY_XML_MAP
 local ____rooms = require("functions.rooms")
@@ -139,7 +141,7 @@ function ____exports.removeAllMatchingGridEntities(self, ...)
 end
 function ____exports.setGridEntityInvisible(self, gridEntity)
     local sprite = gridEntity:GetSprite()
-    sprite:ReplaceSpritesheet(0, "gfx/none.png")
+    sprite:ReplaceSpritesheet(0, EMPTY_PNG_PATH)
     sprite:LoadGraphics()
 end
 function ____exports.spawnGiantPoop(self, topLeftGridIndex)

package/dist/functions/rooms.d.ts

@@ -24,9 +24,9 @@ export declare function getRoomData(): RoomConfig | undefined;
 export declare function getRoomDataType(): int;
 /**
  * Helper function to get the room index of the current room. Use this instead of calling
- * `Game().GetLevel().GetCurrentRoomIndex()` directly to avoid bugs with big rooms.
- * (Big rooms will return the specific 1x1 quadrant that the player entered the room at,
- * which can break data structures that use the room index as an index.)
+ * `Level.GetCurrentRoomIndex()` directly to avoid bugs with big rooms. (Big rooms will return the
+ * specific 1x1 quadrant that the player entered the room at, which can break data structures that
+ * use the room index as an index.)
  */
 export declare function getRoomIndex(): int;
 /**
@@ -38,8 +38,7 @@ export declare function getRoomIndex(): int;
 export declare function getRoomIndexesForType(roomType: RoomType): Set<int>;
 /**
  * Helper function to get the item pool type for the current room. For example, this returns
- * `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room. Returns
- * `DEFAULT_ITEM_POOL_TYPE` if there is no particular pool associated with the current room type.
+ * `ItemPoolType.ItemPoolType.POOL_ANGEL` if you are in an Angel Room.
  */
 export declare function getRoomItemPoolType(): ItemPoolType;
 /**

package/dist/functions/rooms.lua

@@ -2,12 +2,9 @@
 require("lualib_bundle");
 local ____exports = {}
 local ____constants = require("constants")
-local DEFAULT_ITEM_POOL_TYPE = ____constants.DEFAULT_ITEM_POOL_TYPE
 local GENESIS_ROOM_SUBTYPE = ____constants.GENESIS_ROOM_SUBTYPE
 local GENESIS_ROOM_VARIANT = ____constants.GENESIS_ROOM_VARIANT
 local MAX_ROOM_INDEX = ____constants.MAX_ROOM_INDEX
-local ____roomTypeToItemPoolMap = require("maps.roomTypeToItemPoolMap")
-local ROOM_TYPE_TO_ITEM_POOL_TYPE_MAP = ____roomTypeToItemPoolMap.ROOM_TYPE_TO_ITEM_POOL_TYPE_MAP
 local ____doors = require("functions.doors")
 local closeAllDoors = ____doors.closeAllDoors
 local getDoors = ____doors.getDoors
@@ -23,10 +20,6 @@ local hasFlag = ____flag.hasFlag
 function ____exports.getRoomIndex(self)
     local game = Game()
     local level = game:GetLevel()
-    local roomIndex = level:GetCurrentRoomIndex()
-    if roomIndex < 0 then
-        return roomIndex
-    end
     local roomDesc = level:GetCurrentRoomDesc()
     return roomDesc.SafeGridIndex
 end
@@ -88,10 +81,11 @@ function ____exports.getRoomIndexesForType(self, roomType)
 end
 function ____exports.getRoomItemPoolType(self)
     local game = Game()
+    local itemPool = game:GetItemPool()
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local itemPoolType = ROOM_TYPE_TO_ITEM_POOL_TYPE_MAP:get(roomType)
-    return itemPoolType == nil and DEFAULT_ITEM_POOL_TYPE or itemPoolType
+    local roomSeed = room:GetSpawnSeed()
+    return itemPool:GetPoolForRoom(roomType, roomSeed)
 end
 function ____exports.getRoomName(self)
     local roomData = ____exports.getRoomData(nil)
@@ -223,14 +217,14 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue39
+                goto __continue38
             end
             door.State = DoorState.STATE_OPEN
             local sprite = door:GetSprite()
             sprite:Play("Opened", true)
             door.ExtraVisible = false
         end
-        ::__continue39::
+        ::__continue38::
     end
     sfx:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/dist/functions/sprite.d.ts

@@ -1,4 +1,15 @@
 /// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to clear a specific layer from a sprite. This function is variadic, so pass as
+ * many layer IDs as you want to clear.
+ *
+ * Since there is no official API method to "clear" a sprite, we can work around it by setting the
+ * spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does
+ * not exist, then this function might cause spurious errors to appear in the "log.txt file". To
+ * silence these errors, create a transparent 1 pixel PNG file in your mod's resources folder at the
+ * path corresponding to the "EMPTY_PNG_PATH" constant.
+ */
+export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
 /**
  * Helper function that returns the number of the final frame in a particular animation for a
  * sprite. By default, it will use the currently playing animation, but you can also specify a

package/dist/functions/sprite.lua

@@ -1,5 +1,14 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
+function ____exports.clearSprite(self, sprite, ...)
+    local layerIDs = {...}
+    for ____, layerID in ipairs(layerIDs) do
+        sprite:ReplaceSpritesheet(layerID, EMPTY_PNG_PATH)
+    end
+    sprite:LoadGraphics()
+end
 function ____exports.getFinalFrameOfAnimation(self, sprite, animation)
     local currentAnimation = sprite:GetAnimation()
     local currentFrame = sprite:GetFrame()

package/dist/index.d.ts

@@ -52,7 +52,6 @@ export * from "./maps/cardNameMap";
 export * from "./maps/collectibleNameMap";
 export * from "./maps/gridEntityXMLMap";
 export * from "./maps/pillEffectNameMap";
-export * from "./maps/roomTypeToItemPoolMap";
 export * from "./maps/transformationMap";
 export * from "./maps/trinketNameMap";
 export * from "./sets/cards";

package/dist/index.lua

@@ -422,14 +422,6 @@ do
         end
     end
 end
-do
-    local ____export = require("maps.roomTypeToItemPoolMap")
-    for ____exportKey, ____exportValue in pairs(____export) do
-        if ____exportKey ~= "default" then
-            ____exports[____exportKey] = ____exportValue
-        end
-    end
-end
 do
     local ____export = require("maps.transformationMap")
     for ____exportKey, ____exportValue in pairs(____export) do