isaacscript-common 13.0.0 → 13.1.1

package/dist/src/features/customStage/backdrop.lua

@@ -25,8 +25,8 @@ local ____string = require("src.functions.string")
 local removeCharactersBefore = ____string.removeCharactersBefore
 local trimPrefix = ____string.trimPrefix
 local ____utils = require("src.functions.utils")
-local erange = ____utils.erange
-local irange = ____utils.irange
+local eRange = ____utils.eRange
+local iRange = ____utils.iRange
 local ____constants = require("src.features.customStage.constants")
 local ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH = ____constants.ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH
 function getBackdropPNGPath(self, customStage, backdropKind, rng)
@@ -58,7 +58,7 @@ function spawnWallEntity(self, customStage, rng, isExtraWall)
         local cornerPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.CORNER, rng)
         sprite:ReplaceSpritesheet(0, cornerPNGPath)
     end
-    for ____, layerID in ipairs(irange(nil, 1, numWallLayers)) do
+    for ____, layerID in ipairs(iRange(nil, 1, numWallLayers)) do
         local wallPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.WALL, rng)
         sprite:ReplaceSpritesheet(layerID, wallPNGPath)
     end
@@ -97,7 +97,7 @@ function spawnFloorEntity(self, customStage, rng)
     sprite:Load(ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH .. "/floor-backdrop.anm2", false)
     local numFloorLayers = getNumFloorLayers(nil, roomShape)
     if numFloorLayers ~= nil then
-        for ____, layerID in ipairs(erange(nil, 0, numFloorLayers)) do
+        for ____, layerID in ipairs(eRange(nil, 0, numFloorLayers)) do
             local wallPNGPath = getBackdropPNGPath(nil, customStage, BackdropKind.WALL, rng)
             sprite:ReplaceSpritesheet(layerID, wallPNGPath)
         end

package/dist/src/features/customStage/versusScreen.lua

@@ -21,7 +21,7 @@ local getRoomSubType = ____roomData.getRoomSubType
 local ____string = require("src.functions.string")
 local removeCharactersBefore = ____string.removeCharactersBefore
 local ____utils = require("src.functions.utils")
-local erange = ____utils.erange
+local eRange = ____utils.eRange
 local ____bossNamePNGFileNames = require("src.objects.bossNamePNGFileNames")
 local BOSS_NAME_PNG_FILE_NAMES = ____bossNamePNGFileNames.BOSS_NAME_PNG_FILE_NAMES
 local ____bossPortraitPNGFileNames = require("src.objects.bossPortraitPNGFileNames")
@@ -127,7 +127,7 @@ local PLAYER_PORTRAIT_ALT_ANM2_LAYER = 12
 --- These are the non-special layers that we will render last.
 local OTHER_ANM2_LAYERS = arrayRemove(
     nil,
-    erange(nil, NUM_VERSUS_SCREEN_ANM2_LAYERS),
+    eRange(nil, NUM_VERSUS_SCREEN_ANM2_LAYERS),
     BACKGROUND_ANM2_LAYER,
     BOSS_DIRT_SPOT_ANM2_LAYER,
     PLAYER_DIRT_SPOT_ANM2_LAYER,

package/dist/src/features/deployJSONRoom.d.ts

@@ -63,15 +63,4 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom | Readonly<JSONRoom>,
  *                what the function is doing. Default is false.
  */
 export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
-/**
- * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
- * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
- * (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
- * effects (1000), doors, and walls.
- *
- * @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
- *                            decoration, which prevents vanilla entities in the room from
- *                            respawning the next time that the player enters. Default is false.
- */
-export declare function emptyRoom(fillWithDecorations: boolean): void;
 //# sourceMappingURL=deployJSONRoom.d.ts.map

package/dist/src/features/deployJSONRoom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAqDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAwLvD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAuBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAa5D"}
+{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAgDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAwKvD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CA4BN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN"}

package/dist/src/features/deployJSONRoom.lua

@@ -4,11 +4,10 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, emptyRoomEntities, emptyRoomGridEntities, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, EMPTY_ROOM_BLACKLIST_ENTITY_SET, EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EntityCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityCollisionClass
-local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
@@ -27,8 +26,9 @@ local ____featuresInitialized = require("src.featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____array = require("src.functions.array")
 local emptyArray = ____array.emptyArray
+local ____emptyRoom = require("src.functions.emptyRoom")
+local emptyRoom = ____emptyRoom.emptyRoom
 local ____entities = require("src.functions.entities")
-local getEntities = ____entities.getEntities
 local getEntityIDFromConstituents = ____entities.getEntityIDFromConstituents
 local spawn = ____entities.spawn
 local spawnWithSeed = ____entities.spawnWithSeed
@@ -55,7 +55,6 @@ local getRoomListIndex = ____roomData.getRoomListIndex
 local ____roomGrid = require("src.functions.roomGrid")
 local gridCoordinatesToWorldPosition = ____roomGrid.gridCoordinatesToWorldPosition
 local ____rooms = require("src.functions.rooms")
-local roomUpdateSafe = ____rooms.roomUpdateSafe
 local setRoomCleared = ____rooms.setRoomCleared
 local setRoomUncleared = ____rooms.setRoomUncleared
 local ____spawnCollectible = require("src.functions.spawnCollectible")
@@ -138,62 +137,6 @@ function respawnPersistentEntities(self)
         )
     end
 end
---- Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
--- this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
--- (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
--- effects (1000), doors, and walls.
--- 
--- @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
--- decoration, which prevents vanilla entities in the room from
--- respawning the next time that the player enters. Default is false.
-function ____exports.emptyRoom(self, fillWithDecorations)
-    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
-    local roomListIndex = getRoomListIndex(nil)
-    v.level.deployedRoomListIndexes:add(roomListIndex)
-    emptyRoomEntities(nil)
-    emptyRoomGridEntities(nil)
-    setRoomCleared(nil)
-    if fillWithDecorations then
-        fillRoomWithDecorations(nil)
-    end
-end
-function emptyRoomEntities(self)
-    local room = game:GetRoom()
-    for ____, entity in ipairs(getEntities(nil)) do
-        do
-            if EMPTY_ROOM_BLACKLIST_ENTITY_SET:has(entity.Type) then
-                goto __continue33
-            end
-            if entity:HasEntityFlags(EntityFlag.CHARM) or entity:HasEntityFlags(EntityFlag.FRIENDLY) or entity:HasEntityFlags(EntityFlag.PERSISTENT) then
-                goto __continue33
-            end
-            entity:ClearEntityFlags(EntityFlag.APPEAR)
-            entity:Remove()
-            if entity.Type == EntityType.FIREPLACE then
-                local gridIndex = room:GetGridIndex(entity.Position)
-                room:SetGridPath(gridIndex, 0)
-            end
-        end
-        ::__continue33::
-    end
-end
-function emptyRoomGridEntities(self)
-    local removedOneOrMoreGridEntities = false
-    for ____, gridEntity in ipairs(getGridEntities(nil)) do
-        do
-            local gridEntityType = gridEntity:GetType()
-            if EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET:has(gridEntityType) then
-                goto __continue39
-            end
-            removeGridEntity(nil, gridEntity, false)
-            removedOneOrMoreGridEntities = true
-        end
-        ::__continue39::
-    end
-    if removedOneOrMoreGridEntities then
-        roomUpdateSafe(nil)
-    end
-end
 function fillRoomWithDecorations(self)
     local room = game:GetRoom()
     local roomListIndex = getRoomListIndex(nil)
@@ -202,7 +145,7 @@ function fillRoomWithDecorations(self)
         do
             local existingGridEntity = room:GetGridEntity(gridIndex)
             if existingGridEntity ~= nil then
-                goto __continue44
+                goto __continue31
             end
             local position = room:GetGridPosition(gridIndex)
             local decoration = Isaac.GridSpawn(GridEntityType.DECORATION, 0, position)
@@ -211,7 +154,7 @@ function fillRoomWithDecorations(self)
             end
             decorationGridIndexes[#decorationGridIndexes + 1] = gridIndex
         end
-        ::__continue44::
+        ::__continue31::
     end
 end
 function spawnAllEntities(self, jsonRoom, rng, verbose)
@@ -468,20 +411,10 @@ function getPitFrame(self, L, R, U, D, UL, UR, DL, DR)
     end
     return F
 end
-FEATURE_NAME = "deployJSONRoom"
+local FEATURE_NAME = "deployJSONRoom"
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
 local gridEntityXMLTypes = getEnumValues(nil, GridEntityXMLType)
 GRID_ENTITY_XML_TYPE_SET = __TS__New(Set, gridEntityXMLTypes)
-EMPTY_ROOM_BLACKLIST_ENTITY_SET = __TS__New(Set, {
-    EntityType.PLAYER,
-    EntityType.TEAR,
-    EntityType.FAMILIAR,
-    EntityType.LASER,
-    EntityType.KNIFE,
-    EntityType.PROJECTILE,
-    EntityType.DARK_ESAU
-})
-EMPTY_ROOM_BLACKLIST_GRID_ENTITY_SET = __TS__New(Set, {GridEntityType.WALL, GridEntityType.DOOR})
 v = {
     level = {
         deployedRoomListIndexes = __TS__New(Set),
@@ -538,13 +471,16 @@ function ____exports.deployJSONRoom(self, jsonRoom, seedOrRNG, verbose)
     end
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
+    local roomListIndex = getRoomListIndex(nil)
+    v.level.deployedRoomListIndexes:add(roomListIndex)
     if verbose then
         log(nil, "Starting to empty the room of entities and grid entities.")
     end
-    ____exports.emptyRoom(nil, false)
+    emptyRoom(nil)
     if verbose then
         log(nil, "Finished emptying the room of entities and grid entities.")
     end
+    setRoomCleared(nil)
     if verbose then
         log(nil, "Starting to spawn all of the new entities and grid entities.")
     end

package/dist/src/features/extraConsoleCommands/listCommands.lua

@@ -107,7 +107,7 @@ local asCardType = ____types.asCardType
 local asCollectibleType = ____types.asCollectibleType
 local asTrinketType = ____types.asTrinketType
 local ____utils = require("src.functions.utils")
-local irange = ____utils.irange
+local iRange = ____utils.iRange
 local printConsole = ____utils.printConsole
 local printEnabled = ____utils.printEnabled
 local ____cardNameToTypeMap = require("src.maps.cardNameToTypeMap")
@@ -875,7 +875,7 @@ end
 function ____exports.map(self)
     local level = game:GetLevel()
     local displayFlags = addFlag(nil, DisplayFlag.VISIBLE, DisplayFlag.SHADOW, DisplayFlag.SHOW_ICON)
-    for ____, roomGridIndex in ipairs(irange(nil, MAX_LEVEL_GRID_INDEX)) do
+    for ____, roomGridIndex in ipairs(iRange(nil, MAX_LEVEL_GRID_INDEX)) do
         local roomDesc = level:GetRoomByIdx(roomGridIndex)
         roomDesc.DisplayFlags = displayFlags
     end

package/dist/src/features/firstLast.lua

@@ -25,7 +25,7 @@ local asNumber = ____types.asNumber
 local asPillEffect = ____types.asPillEffect
 local asTrinketType = ____types.asTrinketType
 local ____utils = require("src.functions.utils")
-local irange = ____utils.irange
+local iRange = ____utils.iRange
 function postNewRoomEarly(self)
     atLeastOneCallbackFired = true
 end
@@ -165,7 +165,7 @@ function ____exports.getModdedCollectibleTypes(self)
         return {}
     end
     local lastCollectibleType = ____exports.getLastCollectibleType(nil)
-    return irange(nil, firstModdedCollectibleType, lastCollectibleType)
+    return iRange(nil, firstModdedCollectibleType, lastCollectibleType)
 end
 --- This function can only be called if at least one callback has been executed. This is because not
 -- all collectibles will necessarily be present when a mod first loads (due to mod load order).
@@ -223,7 +223,7 @@ function ____exports.getModdedTrinketTypes(self)
         return {}
     end
     local lastTrinketType = ____exports.getLastTrinketType(nil)
-    return irange(nil, firstModdedTrinketType, lastTrinketType)
+    return iRange(nil, firstModdedTrinketType, lastTrinketType)
 end
 --- This function can only be called if at least one callback has been executed. This is because not
 -- all trinkets will necessarily be present when a mod first loads (due to mod load order).
@@ -239,7 +239,7 @@ end
 -- all trinkets will necessarily be present when a mod first loads (due to mod load order).
 function ____exports.getTrinketTypes(self)
     local lastTrinketType = ____exports.getLastTrinketType(nil)
-    return irange(nil, FIRST_TRINKET_TYPE, lastTrinketType)
+    return iRange(nil, FIRST_TRINKET_TYPE, lastTrinketType)
 end
 --- Helper function to get an array with every valid card sub-type. This includes modded cards.
 -- 
@@ -247,7 +247,7 @@ end
 -- all cards will necessarily be present when a mod first loads (due to mod load order).
 function ____exports.getAllCardTypes(self)
     local lastCardType = ____exports.getLastCardType(nil)
-    return irange(nil, FIRST_CARD_TYPE, lastCardType)
+    return iRange(nil, FIRST_CARD_TYPE, lastCardType)
 end
 --- Returns the first modded card sub-type, or undefined if there are no modded cards.
 -- 
@@ -281,7 +281,7 @@ function ____exports.getModdedCardTypes(self)
         return {}
     end
     local lastCardType = ____exports.getLastCardType(nil)
-    return irange(nil, firstModdedCardType, lastCardType)
+    return iRange(nil, firstModdedCardType, lastCardType)
 end
 --- This function can only be called if at least one callback has been executed. This is because not
 -- all trinkets will necessarily be present when a mod first loads (due to mod load order).
@@ -297,7 +297,7 @@ end
 -- all pill effects will necessarily be present when a mod first loads (due to mod load order).
 function ____exports.getAllPillEffects(self)
     local lastPillEffect = ____exports.getLastPillEffect(nil)
-    return irange(nil, FIRST_PILL_EFFECT, lastPillEffect)
+    return iRange(nil, FIRST_PILL_EFFECT, lastPillEffect)
 end
 --- Returns the first modded pill effect, or undefined if there are no modded pill effects.
 -- 
@@ -331,7 +331,7 @@ function ____exports.getModdedPillEffects(self)
         return {}
     end
     local lastPillEffect = ____exports.getLastPillEffect(nil)
-    return irange(nil, firstModdedPillEffect, lastPillEffect)
+    return iRange(nil, firstModdedPillEffect, lastPillEffect)
 end
 --- This function can only be called if at least one callback has been executed. This is because not
 -- all pill effects will necessarily be present when a mod first loads (due to mod load order).

package/dist/src/features/setHotkey.d.ts

@@ -5,19 +5,38 @@ import { Keyboard } from "isaac-typescript-definitions";
  * This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
  * in debugging.
  *
- * @param keyboardOrFunc Either the key that you want to trigger the hotkey or a function that
- *                       returns the key that will trigger the hotkey. Normally, you would just
- *                       specify the key directly, but you can use a function for situations where
- *                       the key can change (like if end-users can specify a custom hotkey using Mod
- *                       Config Menu).
+ * This is different from the `setHotkey` function in that the keyboard activation key is not
+ * hardcoded and is instead the return value of a provided function. This is useful for situations
+ * where the key can change (like if end-users can specify a custom hotkey using Mod Config Menu).
+ *
+ * @param getKeyFunc The function that returns the key that will trigger the hotkey.
  * @param triggerFunc A function containing the arbitrary code that you want to execute when the
  *                    hotkey is triggered.
  */
-export declare function setHotkey(keyboardOrFunc: Keyboard | (() => Keyboard | undefined), triggerFunc: () => void): void;
+export declare function setConditionalHotkey(getKeyFunc: () => Keyboard | undefined, triggerFunc: () => void): void;
+/**
+ * Helper function to run arbitrary code when you press and release a specific keyboard key.
+ *
+ * This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
+ * in debugging.
+ *
+ * @param keyboard The key that you want to trigger the hotkey.
+ * @param triggerFunc A function containing the arbitrary code that you want to execute when the
+ *                    hotkey is triggered.
+ */
+export declare function setHotkey(keyboard: Keyboard, triggerFunc: () => void): void;
+/**
+ * Helper function to remove a hotkey created with the `setConditionalHotkey` function.
+ *
+ * @param getKeyFunc Equal to the `getKeyFunc` that you passed when initially registering the
+ *                   hotkey.
+ */
+export declare function unsetConditionalHotkey(getKeyFunc: () => Keyboard | undefined): void;
 /**
  * Helper function to remove a hotkey created with the `setHotkey` function.
  *
- * @param keyboardOrFunc Equal to the value that you passed when initially registering the hotkey.
+ * @param keyboard Equal to the keyboard value that you passed when initially registering the
+ *                 hotkey.
  */
-export declare function unsetHotkey(keyboardOrFunc: Keyboard | (() => Keyboard | undefined)): void;
+export declare function unsetHotkey(keyboard: Keyboard): void;
 //# sourceMappingURL=setHotkey.d.ts.map

package/dist/src/features/setHotkey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setHotkey.d.ts","sourceRoot":"","sources":["../../../src/features/setHotkey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,8BAA8B,CAAC;AAyDrE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CACvB,cAAc,EAAE,QAAQ,GAAG,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAC,EACvD,WAAW,EAAE,MAAM,IAAI,GACtB,IAAI,CAoBN;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,cAAc,EAAE,QAAQ,GAAG,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAC,GACtD,IAAI,CAoBN"}
+{"version":3,"file":"setHotkey.d.ts","sourceRoot":"","sources":["../../../src/features/setHotkey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAe,MAAM,8BAA8B,CAAC;AAwDrE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,EACtC,WAAW,EAAE,MAAM,IAAI,GACtB,IAAI,CAUN;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,IAAI,GAAG,IAAI,CAU3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,QAAQ,GAAG,SAAS,GACrC,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAUpD"}

package/dist/src/features/setHotkey.lua

@@ -13,8 +13,6 @@ local ____featuresInitialized = require("src.featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____input = require("src.functions.input")
 local isKeyboardPressed = ____input.isKeyboardPressed
-local ____types = require("src.functions.types")
-local isFunction = ____types.isFunction
 function postRender(self)
     for ____, ____value in __TS__Iterator(staticHotkeyFunctionMap:entries()) do
         local keyboard = ____value[1]
@@ -52,42 +50,55 @@ end
 -- This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
 -- in debugging.
 -- 
--- @param keyboardOrFunc Either the key that you want to trigger the hotkey or a function that
--- returns the key that will trigger the hotkey. Normally, you would just
--- specify the key directly, but you can use a function for situations where
--- the key can change (like if end-users can specify a custom hotkey using Mod
--- Config Menu).
+-- This is different from the `setHotkey` function in that the keyboard activation key is not
+-- hardcoded and is instead the return value of a provided function. This is useful for situations
+-- where the key can change (like if end-users can specify a custom hotkey using Mod Config Menu).
+-- 
+-- @param getKeyFunc The function that returns the key that will trigger the hotkey.
 -- @param triggerFunc A function containing the arbitrary code that you want to execute when the
 -- hotkey is triggered.
-function ____exports.setHotkey(self, keyboardOrFunc, triggerFunc)
+function ____exports.setConditionalHotkey(self, getKeyFunc, triggerFunc)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
-    if isFunction(nil, keyboardOrFunc) then
-        if dynamicHotkeyFunctionMap:has(keyboardOrFunc) then
-            error("Failed to register a hotkey due to a custom hotkey already being defined for the submitted function.")
-        end
-        dynamicHotkeyFunctionMap:set(keyboardOrFunc, triggerFunc)
-    else
-        if staticHotkeyFunctionMap:has(keyboardOrFunc) then
-            error(((("Failed to register a hotkey due to a hotkey already being defined for key: Keyboard." .. tostring(Keyboard[keyboardOrFunc])) .. " (") .. tostring(keyboardOrFunc)) .. ")")
-        end
-        staticHotkeyFunctionMap:set(keyboardOrFunc, triggerFunc)
+    if dynamicHotkeyFunctionMap:has(getKeyFunc) then
+        error("Failed to register a hotkey due to a custom hotkey already being defined for the submitted function.")
     end
+    dynamicHotkeyFunctionMap:set(getKeyFunc, triggerFunc)
+end
+--- Helper function to run arbitrary code when you press and release a specific keyboard key.
+-- 
+-- This can be used to easily set up custom hotkeys to facilitate custom game features or to assist
+-- in debugging.
+-- 
+-- @param keyboard The key that you want to trigger the hotkey.
+-- @param triggerFunc A function containing the arbitrary code that you want to execute when the
+-- hotkey is triggered.
+function ____exports.setHotkey(self, keyboard, triggerFunc)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if staticHotkeyFunctionMap:has(keyboard) then
+        error(((("Failed to register a hotkey due to a hotkey already being defined for: Keyboard." .. tostring(Keyboard[keyboard])) .. " (") .. tostring(keyboard)) .. ")")
+    end
+    staticHotkeyFunctionMap:set(keyboard, triggerFunc)
+end
+--- Helper function to remove a hotkey created with the `setConditionalHotkey` function.
+-- 
+-- @param getKeyFunc Equal to the `getKeyFunc` that you passed when initially registering the
+-- hotkey.
+function ____exports.unsetConditionalHotkey(self, getKeyFunc)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    if not dynamicHotkeyFunctionMap:has(getKeyFunc) then
+        error("Failed to unregister a hotkey since there is no existing hotkey defined for the submitted function.")
+    end
+    dynamicHotkeyFunctionMap:delete(getKeyFunc)
 end
 --- Helper function to remove a hotkey created with the `setHotkey` function.
 -- 
--- @param keyboardOrFunc Equal to the value that you passed when initially registering the hotkey.
-function ____exports.unsetHotkey(self, keyboardOrFunc)
+-- @param keyboard Equal to the keyboard value that you passed when initially registering the
+-- hotkey.
+function ____exports.unsetHotkey(self, keyboard)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
-    if isFunction(nil, keyboardOrFunc) then
-        if not dynamicHotkeyFunctionMap:has(keyboardOrFunc) then
-            error("Failed to unregister a hotkey since there is no existing hotkey defined for the submitted function.")
-        end
-        dynamicHotkeyFunctionMap:delete(keyboardOrFunc)
-    else
-        if not staticHotkeyFunctionMap:has(keyboardOrFunc) then
-            error(((("Failed to unregister a hotkey since there is no existing hotkey defined for key: Keyboard." .. tostring(Keyboard[keyboardOrFunc])) .. " (") .. tostring(keyboardOrFunc)) .. ")")
-        end
-        staticHotkeyFunctionMap:delete(keyboardOrFunc)
+    if not staticHotkeyFunctionMap:has(keyboard) then
+        error(((("Failed to unregister a hotkey since there is no existing hotkey defined for: Keyboard." .. tostring(Keyboard[keyboard])) .. " (") .. tostring(keyboard)) .. ")")
     end
+    staticHotkeyFunctionMap:delete(keyboard)
 end
 return ____exports

package/dist/src/functions/array.lua

@@ -25,7 +25,7 @@ local ____types = require("src.functions.types")
 local isNumber = ____types.isNumber
 local isTable = ____types.isTable
 local ____utils = require("src.functions.utils")
-local erange = ____utils.erange
+local eRange = ____utils.eRange
 --- Removes all of the specified element(s) from the array. If the specified element(s) are not found
 -- in the array, this function will do nothing.
 -- 
@@ -343,7 +343,7 @@ end
 -- 
 -- For example, an array of `["Apple", "Banana"]` would return an array of `[0, 1]`.
 function ____exports.getArrayIndexes(self, array)
-    return erange(nil, #array)
+    return eRange(nil, #array)
 end
 --- Helper function to return the last element of an array.
 -- 

package/dist/src/functions/cards.lua

@@ -30,7 +30,7 @@ local ____set = require("src.functions.set")
 local addSetsToSet = ____set.addSetsToSet
 local getRandomSetElement = ____set.getRandomSetElement
 local ____utils = require("src.functions.utils")
-local irange = ____utils.irange
+local iRange = ____utils.iRange
 function lazyInitCardMapsSets(self)
     for ____, cardType in ipairs(getEnumValues(nil, ItemConfigCardType)) do
         ITEM_CONFIG_CARD_TYPE_TO_CARD_TYPE_MAP:set(
@@ -82,7 +82,7 @@ function ____exports.getItemConfigCardType(self, cardType)
 end
 --- Helper function to get an array with every valid vanilla card sub-type.
 function ____exports.getVanillaCardTypes(self)
-    return irange(nil, FIRST_CARD_TYPE, LAST_VANILLA_CARD_TYPE)
+    return iRange(nil, FIRST_CARD_TYPE, LAST_VANILLA_CARD_TYPE)
 end
 --- Returns true for any vanilla card or rune.
 function ____exports.isVanillaCardType(self, cardType)

package/dist/src/functions/collectibles.lua

@@ -38,7 +38,7 @@ local ____sprites = require("src.functions.sprites")
 local clearSprite = ____sprites.clearSprite
 local spriteEquals = ____sprites.spriteEquals
 local ____utils = require("src.functions.utils")
-local irange = ____utils.irange
+local iRange = ____utils.iRange
 function initQuestionMarkSprite(self)
     local sprite = Sprite()
     sprite:Load("gfx/005.100_collectible.anm2", false)
@@ -349,7 +349,7 @@ end
 -- should use the `getVanillaCollectibleArray` or `getVanillaCollectibleSet` helper functions
 -- instead.
 function ____exports.getVanillaCollectibleTypeRange(self)
-    return irange(nil, FIRST_COLLECTIBLE_TYPE, LAST_VANILLA_COLLECTIBLE_TYPE)
+    return iRange(nil, FIRST_COLLECTIBLE_TYPE, LAST_VANILLA_COLLECTIBLE_TYPE)
 end
 --- Returns true if the item type in the item config is equal to `ItemType.ITEM_ACTIVE`.
 function ____exports.isActiveCollectible(self, collectibleType)

package/dist/src/functions/dimensions.lua

@@ -8,10 +8,10 @@ local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
 local ____roomData = require("src.functions.roomData")
 local getRoomGridIndex = ____roomData.getRoomGridIndex
 local ____utils = require("src.functions.utils")
-local erange = ____utils.erange
+local eRange = ____utils.eRange
 --- Helper function to get an array with every valid `Dimension` (not including `Dimension.CURRENT`).
 function ____exports.getAllDimensions(self)
-    return erange(nil, NUM_DIMENSIONS)
+    return eRange(nil, NUM_DIMENSIONS)
 end
 --- Helper function to get the current dimension. Most of the time, this will be `Dimension.MAIN`,
 -- but it can change if e.g. the player is in the mirror world of Downpour/Dross.

package/dist/src/functions/emptyRoom.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
+ * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
+ * (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
+ * effects (1000), doors, and walls.
+ */
+export declare function emptyRoom(): void;
+//# sourceMappingURL=emptyRoom.d.ts.map

package/dist/src/functions/emptyRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emptyRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/emptyRoom.ts"],"names":[],"mappings":"AAqBA;;;;;GAKG;AACH,wBAAgB,SAAS,IAAI,IAAI,CAGhC"}

package/dist/src/functions/emptyRoom.lua

@@ -0,0 +1,79 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local emptyRoomEntities, emptyRoomGridEntities, EMPTY_ROOM_BLACKLIST_ENTITY_SET
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____entities = require("src.functions.entities")
+local getEntities = ____entities.getEntities
+local ____gridEntities = require("src.functions.gridEntities")
+local getGridEntities = ____gridEntities.getGridEntities
+local removeGridEntity = ____gridEntities.removeGridEntity
+local ____rooms = require("src.functions.rooms")
+local roomUpdateSafe = ____rooms.roomUpdateSafe
+local ____roomShapeWalls = require("src.functions.roomShapeWalls")
+local isVanillaWallGridIndex = ____roomShapeWalls.isVanillaWallGridIndex
+function emptyRoomEntities(self)
+    local room = game:GetRoom()
+    for ____, entity in ipairs(getEntities(nil)) do
+        do
+            if EMPTY_ROOM_BLACKLIST_ENTITY_SET:has(entity.Type) then
+                goto __continue4
+            end
+            if entity:HasEntityFlags(EntityFlag.CHARM) or entity:HasEntityFlags(EntityFlag.FRIENDLY) or entity:HasEntityFlags(EntityFlag.PERSISTENT) then
+                goto __continue4
+            end
+            entity:ClearEntityFlags(EntityFlag.APPEAR)
+            entity:Remove()
+            if entity.Type == EntityType.FIREPLACE then
+                local gridIndex = room:GetGridIndex(entity.Position)
+                room:SetGridPath(gridIndex, 0)
+            end
+        end
+        ::__continue4::
+    end
+end
+function emptyRoomGridEntities(self)
+    local removedOneOrMoreGridEntities = false
+    for ____, gridEntity in ipairs(getGridEntities(nil)) do
+        do
+            local gridEntityType = gridEntity:GetType()
+            local gridIndex = gridEntity:GetGridIndex()
+            if gridEntityType == GridEntityType.WALL and isVanillaWallGridIndex(nil, gridIndex) then
+                goto __continue10
+            end
+            if gridEntityType == GridEntityType.DOOR then
+                goto __continue10
+            end
+            removeGridEntity(nil, gridEntity, false)
+            removedOneOrMoreGridEntities = true
+        end
+        ::__continue10::
+    end
+    if removedOneOrMoreGridEntities then
+        roomUpdateSafe(nil)
+    end
+end
+EMPTY_ROOM_BLACKLIST_ENTITY_SET = __TS__New(Set, {
+    EntityType.PLAYER,
+    EntityType.TEAR,
+    EntityType.FAMILIAR,
+    EntityType.LASER,
+    EntityType.KNIFE,
+    EntityType.PROJECTILE,
+    EntityType.DARK_ESAU
+})
+--- Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
+-- this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles
+-- (9), blacklisted NPCs such as Dark Esau, charmed NPCs, friendly NPCs, persistent NPCs, most
+-- effects (1000), doors, and walls.
+function ____exports.emptyRoom(self)
+    emptyRoomEntities(nil)
+    emptyRoomGridEntities(nil)
+end
+return ____exports

package/dist/src/functions/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,MAAM,EAAE,CAG1D;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,GAAG,CAGvD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAWjE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAqBN"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,MAAM,EAAE,CAG1D;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,GAAG,CAGvD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAWjE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN"}