isaacscript-common 14.2.0 → 15.0.0

package/dist/src/classes/features/other/PlayerInventory.lua

@@ -0,0 +1,63 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____array = require("src.functions.array")
+local arrayRemoveInPlace = ____array.arrayRemoveInPlace
+local copyArray = ____array.copyArray
+local getLastElement = ____array.getLastElement
+local ____collectibles = require("src.functions.collectibles")
+local isActiveCollectible = ____collectibles.isActiveCollectible
+local ____playerDataStructures = require("src.functions.playerDataStructures")
+local defaultMapGetPlayer = ____playerDataStructures.defaultMapGetPlayer
+local ____DefaultMap = require("src.classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+____exports.PlayerInventory = __TS__Class()
+local PlayerInventory = ____exports.PlayerInventory
+PlayerInventory.name = "PlayerInventory"
+__TS__ClassExtends(PlayerInventory, Feature)
+function PlayerInventory.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.v = {run = {playersInventory = __TS__New(
+        DefaultMap,
+        function() return {} end
+    )}}
+    self.postCollectibleAdded = function(____, player, collectibleType)
+        local inventory = defaultMapGetPlayer(nil, self.v.run.playersInventory, player, player)
+        inventory[#inventory + 1] = collectibleType
+    end
+    self.postCollectibleRemoved = function(____, player, collectibleType)
+        local inventory = defaultMapGetPlayer(nil, self.v.run.playersInventory, player, player)
+        arrayRemoveInPlace(nil, inventory, collectibleType)
+    end
+    self.customCallbacksUsed = {{ModCallbackCustom.POST_PLAYER_COLLECTIBLE_ADDED, {self.postCollectibleAdded}}, {ModCallbackCustom.POST_PLAYER_COLLECTIBLE_REMOVED, {self.postCollectibleRemoved}}}
+end
+function PlayerInventory.prototype.getPlayerInventory(self, player, includeActiveCollectibles)
+    if includeActiveCollectibles == nil then
+        includeActiveCollectibles = true
+    end
+    local inventory = defaultMapGetPlayer(nil, self.v.run.playersInventory, player, player)
+    if includeActiveCollectibles then
+        return copyArray(nil, inventory)
+    end
+    return __TS__ArrayFilter(
+        inventory,
+        function(____, collectibleType) return not isActiveCollectible(nil, collectibleType) end
+    )
+end
+function PlayerInventory.prototype.getPlayerLastPassiveCollectible(self, player)
+    local inventory = self:getPlayerInventory(player, false)
+    return getLastElement(nil, inventory)
+end
+__TS__Decorate({Exported}, PlayerInventory.prototype, "getPlayerInventory", true)
+__TS__Decorate({Exported}, PlayerInventory.prototype, "getPlayerLastPassiveCollectible", true)
+return ____exports

package/dist/src/classes/features/other/PonyDetection.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="isaac-typescript-definitions" />
+import { Feature } from "../../private/Feature";
+export declare class PonyDetection extends Feature {
+    private postPEffectUpdateReordered;
+    /**
+     * Helper function to see if the player is under the effects of A Pony or White Pony charge.
+     * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
+     */
+    isPlayerUsingPony(player: EntityPlayer): boolean;
+    /**
+     * Helper function to see if any player is under the effects of A Pony or White Pony charge.
+     * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
+     */
+    anyPlayerUsingPony(): boolean;
+}
+//# sourceMappingURL=PonyDetection.d.ts.map

package/dist/src/classes/features/other/PonyDetection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PonyDetection.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PonyDetection.ts"],"names":[],"mappings":";AAWA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,aAAc,SAAQ,OAAO;IAqBxC,OAAO,CAAC,0BAA0B,CAmBhC;IAEF;;;OAGG;IAEI,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO;IAIvD;;;OAGG;IAEI,kBAAkB,IAAI,OAAO;CAIrC"}

package/dist/src/classes/features/other/PonyDetection.lua

@@ -0,0 +1,65 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__Decorate = ____lualib.__TS__Decorate
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____flag = require("src.functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____playerDataStructures = require("src.functions.playerDataStructures")
+local setAddPlayer = ____playerDataStructures.setAddPlayer
+local setDeletePlayer = ____playerDataStructures.setDeletePlayer
+local setHasPlayer = ____playerDataStructures.setHasPlayer
+local ____playerIndex = require("src.functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+local FLAGS_WHEN_PONY_IS_ACTIVE = {EntityFlag.NO_KNOCKBACK, EntityFlag.NO_PHYSICS_KNOCKBACK, EntityFlag.NO_DAMAGE_BLINK}
+____exports.PonyDetection = __TS__Class()
+local PonyDetection = ____exports.PonyDetection
+PonyDetection.name = "PonyDetection"
+__TS__ClassExtends(PonyDetection, Feature)
+function PonyDetection.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.v = {run = {playersIsPonyActive = __TS__New(Set)}}
+    self.postPEffectUpdateReordered = function(____, player)
+        local effects = player:GetEffects()
+        local entityFlags = player:GetEntityFlags()
+        local hasPonyCollectibleEffect = effects:HasCollectibleEffect(CollectibleType.PONY) or effects:HasCollectibleEffect(CollectibleType.WHITE_PONY)
+        local isPonyActiveOnPreviousFrame = setHasPlayer(nil, self.v.run.playersIsPonyActive, player)
+        local hasPonyFlags = hasFlag(
+            nil,
+            entityFlags,
+            table.unpack(FLAGS_WHEN_PONY_IS_ACTIVE)
+        )
+        local isPonyActiveNow = hasPonyCollectibleEffect or isPonyActiveOnPreviousFrame and hasPonyFlags
+        if isPonyActiveNow then
+            setAddPlayer(nil, self.v.run.playersIsPonyActive, player)
+        else
+            setDeletePlayer(nil, self.v.run.playersIsPonyActive, player)
+        end
+    end
+    self.customCallbacksUsed = {{ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED, {self.postPEffectUpdateReordered}}}
+end
+function PonyDetection.prototype.isPlayerUsingPony(self, player)
+    return setHasPlayer(nil, self.v.run.playersIsPonyActive, player)
+end
+function PonyDetection.prototype.anyPlayerUsingPony(self)
+    local players = getPlayers(nil)
+    return __TS__ArraySome(
+        players,
+        function(____, player) return self:isPlayerUsingPony(player) end
+    )
+end
+__TS__Decorate({Exported}, PonyDetection.prototype, "isPlayerUsingPony", true)
+__TS__Decorate({Exported}, PonyDetection.prototype, "anyPlayerUsingPony", true)
+return ____exports

package/dist/src/classes/features/other/PreventChildEntities.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="isaac-typescript-definitions" />
+import { Feature } from "../../private/Feature";
+export declare class PreventChildEntities extends Feature {
+    private postNPCInit;
+    /**
+     * Helper function to prevent an entity from spawning any other entities. Meant to be used on NPCs
+     * like Squirts. This behavior will only last for the current room.
+     *
+     * Under the hood, this function will remove any new NPCs spawned that have a
+     * `Entity.SpawnerEntity` or `Entity.Parent` value that matches the provided entity. (They are
+     * removed during the `POST_NPC_INIT` callback specifically.)
+     */
+    preventChildEntities(entity: Entity): void;
+}
+//# sourceMappingURL=PreventChildEntities.d.ts.map

package/dist/src/classes/features/other/PreventChildEntities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreventChildEntities.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventChildEntities.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,oBAAqB,SAAQ,OAAO;IAkB/C,OAAO,CAAC,WAAW,CAYjB;IAEF;;;;;;;OAOG;IAEI,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAIlD"}

package/dist/src/classes/features/other/PreventChildEntities.lua

@@ -0,0 +1,35 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+____exports.PreventChildEntities = __TS__Class()
+local PreventChildEntities = ____exports.PreventChildEntities
+PreventChildEntities.name = "PreventChildEntities"
+__TS__ClassExtends(PreventChildEntities, Feature)
+function PreventChildEntities.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.v = {room = {preventingEntities = __TS__New(Set)}}
+    self.postNPCInit = function(____, npc)
+        local spawnerEntityMatch = npc.SpawnerEntity ~= nil and self.v.room.preventingEntities:has(GetPtrHash(npc.SpawnerEntity))
+        local parentMatch = npc.Parent ~= nil and self.v.room.preventingEntities:has(GetPtrHash(npc.Parent))
+        if spawnerEntityMatch or parentMatch then
+            npc:Remove()
+        end
+    end
+    self.callbacksUsed = {{ModCallback.POST_NPC_INIT, {self.postNPCInit}}}
+end
+function PreventChildEntities.prototype.preventChildEntities(self, entity)
+    local ptrHash = GetPtrHash(entity)
+    self.v.room.preventingEntities:add(ptrHash)
+end
+__TS__Decorate({Exported}, PreventChildEntities.prototype, "preventChildEntities", true)
+return ____exports

package/dist/src/classes/features/other/PreventCollectibleRotation.d.ts

@@ -0,0 +1,18 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+import { Feature } from "../../private/Feature";
+export declare class PreventCollectibleRotation extends Feature {
+    private useCardSoulOfIsaac;
+    private postPickupUpdateCollectible;
+    private checkCollectibleRotated;
+    /**
+     * Helper function to prevent a collectible from being affected by Tainted Isaac's rotation
+     * mechanic. (This mechanic also happens from Glitched Crown and Binge Eater.) This is useful
+     * because quest items that are manually spawned by mods will be automatically be affected by this
+     * mechanic.
+     *
+     * It is required to pass the intended collectible type to this function since it is possible for
+     * collectibles to rotate on the first frame that they are spawned.
+     */
+    preventCollectibleRotation(collectible: EntityPickup, collectibleType: CollectibleType): void;
+}
+//# sourceMappingURL=PreventCollectibleRotation.d.ts.map

package/dist/src/classes/features/other/PreventCollectibleRotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreventCollectibleRotation.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventCollectibleRotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,0BAA2B,SAAQ,OAAO;IAoCrD,OAAO,CAAC,kBAAkB,CAIxB;IAIF,OAAO,CAAC,2BAA2B,CAIjC;IAEF,OAAO,CAAC,uBAAuB;IAiB/B;;;;;;;;OAQG;IAEI,0BAA0B,CAC/B,WAAW,EAAE,YAAY,EACzB,eAAe,EAAE,eAAe,GAC/B,IAAI;CAeR"}

package/dist/src/classes/features/other/PreventCollectibleRotation.lua

@@ -0,0 +1,67 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local getMapIndex
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CardType = ____isaac_2Dtypescript_2Ddefinitions.CardType
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____collectibles = require("src.functions.collectibles")
+local setCollectibleSubType = ____collectibles.setCollectibleSubType
+local ____entities = require("src.functions.entities")
+local getEntityID = ____entities.getEntityID
+local ____pickupVariants = require("src.functions.pickupVariants")
+local isCollectible = ____pickupVariants.isCollectible
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+function getMapIndex(self, collectible)
+    local room = game:GetRoom()
+    local gridIndex = room:GetGridIndex(collectible.Position)
+    return (tostring(gridIndex) .. ",") .. tostring(collectible.InitSeed)
+end
+____exports.PreventCollectibleRotation = __TS__Class()
+local PreventCollectibleRotation = ____exports.PreventCollectibleRotation
+PreventCollectibleRotation.name = "PreventCollectibleRotation"
+__TS__ClassExtends(PreventCollectibleRotation, Feature)
+function PreventCollectibleRotation.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.v = {room = {trackedCollectibles = __TS__New(Map)}}
+    self.useCardSoulOfIsaac = function()
+        self.v.room.trackedCollectibles:clear()
+    end
+    self.postPickupUpdateCollectible = function(____, pickup)
+        local collectible = pickup
+        self:checkCollectibleRotated(collectible)
+    end
+    self.callbacksUsed = {{ModCallback.POST_USE_CARD, {self.useCardSoulOfIsaac, CardType.SOUL_ISAAC}}, {ModCallback.POST_PICKUP_UPDATE, {self.postPickupUpdateCollectible, PickupVariant.COLLECTIBLE}}}
+end
+function PreventCollectibleRotation.prototype.checkCollectibleRotated(self, collectible)
+    if collectible.SubType == CollectibleType.NULL then
+        return
+    end
+    local index = getMapIndex(nil, collectible)
+    local trackedCollectibleType = self.v.room.trackedCollectibles:get(index)
+    if trackedCollectibleType ~= nil and collectible.SubType ~= trackedCollectibleType then
+        setCollectibleSubType(nil, collectible, trackedCollectibleType)
+    end
+end
+function PreventCollectibleRotation.prototype.preventCollectibleRotation(self, collectible, collectibleType)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"preventCollectibleRotate\" function was given a non-collectible: " .. entityID)
+    end
+    local index = getMapIndex(nil, collectible)
+    self.v.room.trackedCollectibles:set(index, collectibleType)
+    self:checkCollectibleRotated(collectible)
+end
+__TS__Decorate({Exported}, PreventCollectibleRotation.prototype, "preventCollectibleRotation", true)
+return ____exports

package/dist/src/classes/features/other/PreventGridEntityRespawn.d.ts

@@ -0,0 +1,33 @@
+import { Feature } from "../../private/Feature";
+export declare class PreventGridEntityRespawn extends Feature {
+    private runInNFrames;
+    private preUseItemWeNeedToGoDeeper;
+    private postNewRoomReordered;
+    /**
+     * Every time we re-enter the room, the sprites for all of the decorations will come back, so we
+     * have to remove them again.
+     */
+    private setDecorationsInvisible;
+    /**
+     * Helper function to prevent any removed grid entities from respawning if the player re-enters
+     * the current room.
+     *
+     * This is accomplished by spawning a new grid entity on every tile that does not already have a
+     * grid entity. This will force the game to spawn the new grid entity instead of the old one. The
+     * natural grid entity to choose for this purpose is a decoration, since it is non-interacting.
+     * Then, the decorations are made invisible and any shovel uses are intercepted to avoid creating
+     * a crawl space (instead of a trapdoor).
+     *
+     * Another option besides decorations would be to use a pressure plates with a state of 1, which
+     * is a state that is normally unused by the game and makes it invisible & persistent. However,
+     * pickups will not be able to spawn on pressure plates, which lead to various bugs (e.g. pickups
+     * spawning on top of pits). Thus, using a decoration is preferable.
+     *
+     * Yet another option to accomplish this would be to replace the room data with that of an empty
+     * room. However, the room data must exactly match the room type, the room shape, and the doors,
+     * so this is not possible to do in a robust way without adding empty rooms to the mod's `content`
+     * folder to draw the data from.
+     */
+    preventGridEntityRespawn(): void;
+}
+//# sourceMappingURL=PreventGridEntityRespawn.d.ts.map

package/dist/src/classes/features/other/PreventGridEntityRespawn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreventGridEntityRespawn.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/PreventGridEntityRespawn.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGhD,qBAAa,wBAAyB,SAAQ,OAAO;IAcnD,OAAO,CAAC,YAAY,CAAe;IAwBnC,OAAO,CAAC,0BAA0B,CAqDhC;IAGF,OAAO,CAAC,oBAAoB,CAE1B;IAEF;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAsB/B;;;;;;;;;;;;;;;;;;;OAmBG;IAEI,wBAAwB,IAAI,IAAI;CAuBxC"}

package/dist/src/classes/features/other/PreventGridEntityRespawn.lua

@@ -0,0 +1,124 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__New = ____lualib.__TS__New
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____ISCFeature = require("src.enums.ISCFeature")
+local ISCFeature = ____ISCFeature.ISCFeature
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____array = require("src.functions.array")
+local emptyArray = ____array.emptyArray
+local ____gridEntities = require("src.functions.gridEntities")
+local getAllGridIndexes = ____gridEntities.getAllGridIndexes
+local getGridEntities = ____gridEntities.getGridEntities
+local removeGridEntity = ____gridEntities.removeGridEntity
+local setGridEntityInvisible = ____gridEntities.setGridEntityInvisible
+local spawnGridEntity = ____gridEntities.spawnGridEntity
+local ____players = require("src.functions.players")
+local getPlayerFromPtr = ____players.getPlayerFromPtr
+local ____roomData = require("src.functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
+local ____DefaultMap = require("src.classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+____exports.PreventGridEntityRespawn = __TS__Class()
+local PreventGridEntityRespawn = ____exports.PreventGridEntityRespawn
+PreventGridEntityRespawn.name = "PreventGridEntityRespawn"
+__TS__ClassExtends(PreventGridEntityRespawn, Feature)
+function PreventGridEntityRespawn.prototype.____constructor(self, runInNFrames)
+    Feature.prototype.____constructor(self)
+    self.v = {
+        level = {roomListIndexToDecorationGridIndexes = __TS__New(
+            DefaultMap,
+            function() return {} end
+        )},
+        room = {manuallyUsingShovel = false}
+    }
+    self.preUseItemWeNeedToGoDeeper = function(____, _collectibleType, _rng, player, _useFlags, _activeSlot, _customVarData)
+        if self.v.room.manuallyUsingShovel then
+            return nil
+        end
+        local roomListIndex = getRoomListIndex(nil)
+        if not self.v.level.roomListIndexToDecorationGridIndexes:has(roomListIndex) then
+            return
+        end
+        local decorations = getGridEntities(nil, GridEntityType.DECORATION)
+        for ____, decoration in ipairs(decorations) do
+            removeGridEntity(nil, decoration, false)
+        end
+        local entityPtr = EntityPtr(player)
+        self.runInNFrames:runNextGameFrame(function()
+            local futurePlayer = getPlayerFromPtr(nil, entityPtr)
+            if futurePlayer == nil then
+                return
+            end
+            local futureRoomListIndex = getRoomListIndex(nil)
+            if futureRoomListIndex ~= roomListIndex then
+                return
+            end
+            self.v.room.manuallyUsingShovel = true
+            futurePlayer:UseActiveItem(CollectibleType.WE_NEED_TO_GO_DEEPER)
+            self.v.room.manuallyUsingShovel = false
+            local decorationGridIndexes = self.v.level.roomListIndexToDecorationGridIndexes:getAndSetDefault(roomListIndex)
+            emptyArray(nil, decorationGridIndexes)
+            self:preventGridEntityRespawn()
+        end)
+        return true
+    end
+    self.postNewRoomReordered = function()
+        self:setDecorationsInvisible()
+    end
+    self.featuresUsed = {ISCFeature.RUN_IN_N_FRAMES}
+    self.callbacksUsed = {{ModCallback.PRE_USE_ITEM, {self.preUseItemWeNeedToGoDeeper, CollectibleType.WE_NEED_TO_GO_DEEPER}}}
+    self.customCallbacksUsed = {{ModCallbackCustom.POST_NEW_ROOM_REORDERED, {self.postNewRoomReordered}}}
+    self.runInNFrames = runInNFrames
+end
+function PreventGridEntityRespawn.prototype.setDecorationsInvisible(self)
+    local room = game:GetRoom()
+    local roomListIndex = getRoomListIndex(nil)
+    local decorationGridIndexes = self.v.level.roomListIndexToDecorationGridIndexes:get(roomListIndex)
+    if decorationGridIndexes == nil then
+        return
+    end
+    for ____, gridIndex in ipairs(decorationGridIndexes) do
+        local gridEntity = room:GetGridEntity(gridIndex)
+        if gridEntity ~= nil then
+            local gridEntityType = gridEntity:GetType()
+            if gridEntityType == GridEntityType.DECORATION then
+                setGridEntityInvisible(nil, gridEntity)
+            end
+        end
+    end
+end
+function PreventGridEntityRespawn.prototype.preventGridEntityRespawn(self)
+    local room = game:GetRoom()
+    local roomListIndex = getRoomListIndex(nil)
+    local decorationGridIndexes = self.v.level.roomListIndexToDecorationGridIndexes:getAndSetDefault(roomListIndex)
+    for ____, gridIndex in ipairs(getAllGridIndexes(nil)) do
+        do
+            local existingGridEntity = room:GetGridEntity(gridIndex)
+            if existingGridEntity ~= nil then
+                goto __continue20
+            end
+            local decoration = spawnGridEntity(nil, GridEntityType.DECORATION, gridIndex)
+            if decoration ~= nil then
+                setGridEntityInvisible(nil, decoration)
+            end
+            decorationGridIndexes[#decorationGridIndexes + 1] = gridIndex
+        end
+        ::__continue20::
+    end
+end
+__TS__Decorate({Exported}, PreventGridEntityRespawn.prototype, "preventGridEntityRespawn", true)
+return ____exports

package/dist/src/classes/features/other/RoomClearFrame.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="isaac-typescript-definitions" />
+import { Feature } from "../../private/Feature";
+export declare class RoomClearFrame extends Feature {
+    private postRoomClearChangedTrue;
+    /**
+     * Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this
+     * room was cleared. Returns undefined if the room has never been cleared.
+     */
+    getRoomClearGameFrame(): int | undefined;
+    /**
+     * Helper function to get the room frame (i.e. `Room.GetFrameCount`) of the last time that this
+     * room was cleared. Returns undefined if the room has never been cleared.
+     */
+    getRoomClearRoomFrame(): int | undefined;
+}
+//# sourceMappingURL=RoomClearFrame.d.ts.map

package/dist/src/classes/features/other/RoomClearFrame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomClearFrame.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomClearFrame.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,cAAe,SAAQ,OAAO;IAuBzC,OAAO,CAAC,wBAAwB,CAO9B;IAEF;;;OAGG;IAEI,qBAAqB,IAAI,GAAG,GAAG,SAAS;IAI/C;;;OAGG;IAEI,qBAAqB,IAAI,GAAG,GAAG,SAAS;CAGhD"}

package/dist/src/classes/features/other/RoomClearFrame.lua

@@ -0,0 +1,38 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__Decorate = ____lualib.__TS__Decorate
+local ____exports = {}
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____decorators = require("src.decorators")
+local Exported = ____decorators.Exported
+local ____ModCallbackCustom = require("src.enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____Feature = require("src.classes.private.Feature")
+local Feature = ____Feature.Feature
+____exports.RoomClearFrame = __TS__Class()
+local RoomClearFrame = ____exports.RoomClearFrame
+RoomClearFrame.name = "RoomClearFrame"
+__TS__ClassExtends(RoomClearFrame, Feature)
+function RoomClearFrame.prototype.____constructor(self)
+    Feature.prototype.____constructor(self)
+    self.v = {room = {roomClearGameFrame = nil, roomClearRoomFrame = nil}}
+    self.postRoomClearChangedTrue = function()
+        local gameFrameCount = game:GetFrameCount()
+        local room = game:GetRoom()
+        local roomFrameCount = room:GetFrameCount()
+        self.v.room.roomClearGameFrame = gameFrameCount
+        self.v.room.roomClearRoomFrame = roomFrameCount
+    end
+    self.customCallbacksUsed = {{ModCallbackCustom.POST_ROOM_CLEAR_CHANGED, {self.postRoomClearChangedTrue}}}
+end
+function RoomClearFrame.prototype.getRoomClearGameFrame(self)
+    return self.v.room.roomClearGameFrame
+end
+function RoomClearFrame.prototype.getRoomClearRoomFrame(self)
+    return self.v.room.roomClearGameFrame
+end
+__TS__Decorate({Exported}, RoomClearFrame.prototype, "getRoomClearGameFrame", true)
+__TS__Decorate({Exported}, RoomClearFrame.prototype, "getRoomClearRoomFrame", true)
+return ____exports

package/dist/src/classes/features/other/RoomHistory.d.ts

@@ -0,0 +1,38 @@
+import { RoomDescription } from "../../../interfaces/RoomDescription";
+import { Feature } from "../../private/Feature";
+export declare class RoomHistory extends Feature {
+    private postNewRoomEarly;
+    /**
+     * Helper function to get information about all of the rooms that a player has visited thus far on
+     * this run.
+     */
+    getRoomHistory(): ReadonlyArray<Readonly<RoomDescription>>;
+    /**
+     * Helper function to get information about the room that was previously visited.
+     *
+     * In the special case of only one room having been visited thus far (i.e. the starting room of
+     * the run), the starting room will be returned.
+     */
+    getPreviousRoomDescription(): Readonly<RoomDescription>;
+    /**
+     * Helper function to get information about the most recent room that is stored in the room
+     * history array.
+     *
+     * This is useful in the `POST_ENTITY_REMOVE` callback; see the `isLeavingRoom` function.
+     *
+     * Note that this function can return undefined in the case where it is called on the first room
+     * of the run.
+     */
+    getLatestRoomDescription(): Readonly<RoomDescription> | undefined;
+    /**
+     * Helper function to detect if the game is in the state where the room index has changed to a new
+     * room, but the entities from the previous room are currently in the process of despawning. (At
+     * this point, the `POST_NEW_ROOM` callback will not have fired yet, and there will not be an
+     * entry in the room history array for the current room.)
+     *
+     * This function is intended to be used in the `POST_ENTITY_REMOVE` callback to detect when an
+     * entity is despawning.
+     */
+    isLeavingRoom(): boolean;
+}
+//# sourceMappingURL=RoomHistory.d.ts.map

package/dist/src/classes/features/other/RoomHistory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,qBAAa,WAAY,SAAQ,OAAO;IAkBtC,OAAO,CAAC,gBAAgB,CA6BtB;IAEF;;;OAGG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;OAKG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAiB9D;;;;;;;;OAQG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE;;;;;;;;OAQG;IAEI,aAAa,IAAI,OAAO;CAqBhC"}