isaacscript-common 12.5.0 → 12.5.2

package/dist/index.d.ts

@@ -1665,6 +1665,12 @@ export declare class DefaultMap<Key, Value, Args extends unknown[] = []> extends
     getConstructorArg(): Value | FactoryFunction<Value, Args>;
 }
 
+/**
+ * Helper function to get the value from a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export declare function defaultMapGetHash<V, A extends unknown[]>(map: DefaultMap<PtrHash, V, A>, entity: Entity, ...extraArgs: A): V;
+
 /**
  * Helper function to make using default maps with an index of `PlayerIndex` easier. Use this
  * instead of the `DefaultMap.getAndSetDefault` method if you have a default map of this type.
@@ -1685,6 +1691,15 @@ export declare class DefaultMap<Key, Value, Args extends unknown[] = []> extends
  */
 export declare function defaultMapGetPlayer<V, A extends unknown[]>(map: DefaultMap<PlayerIndex, V, A>, player: EntityPlayer, ...extraArgs: A): V;
 
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ *
+ * Since `Map` and `DefaultMap` set values in the same way, this function is simply an alias for the
+ * `mapSetHash` helper function.
+ */
+export declare function defaultMapSetHash<V>(map: Map<PtrHash, V>, entity: Entity, value: V): void;
+
 /**
  * Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
  * `Map.set` method if you have a map of this type.
@@ -3603,8 +3618,11 @@ export declare function getLastTrinketType(): TrinketType;
  * 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.
  */
-export declare function getLatestRoomDescription(): RoomDescription;
+export declare function getLatestRoomDescription(): RoomDescription | undefined;
 
 /**
  * Helper function to get the closest value from a map based on partial search text. For the
@@ -6175,7 +6193,7 @@ export declare function isLaser(variable: unknown): variable is EntityLaser;
  * 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 pseudo-persistent entity such as a pickup is despawning.
+ * entity is despawning.
  */
 export declare function isLeavingRoom(): boolean;
 
@@ -6993,6 +7011,12 @@ export declare function mapGetPlayer<V>(map: Map<PlayerIndex, V>, player: Entity
  */
 export declare function mapHasPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer): boolean;
 
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export declare function mapSetHash<V>(map: Map<PtrHash, V>, entity: Entity, value: V): void;
+
 /**
  * Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
  * `Map.set` method if you have a map of this type.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 12.5.0
+isaacscript-common 12.5.2
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -9323,7 +9323,7 @@ ____exports.ClottyVariant.GRILLED_CLOTTY = 3
 ____exports.ClottyVariant[____exports.ClottyVariant.GRILLED_CLOTTY] = "GRILLED_CLOTTY"
 --- For `EntityType.MULLIGAN` (16).
 ____exports.MulliganVariant = {}
-____exports.MulliganVariant.MULLIGAN = 16
+____exports.MulliganVariant.MULLIGAN = 0
 ____exports.MulliganVariant[____exports.MulliganVariant.MULLIGAN] = "MULLIGAN"
 ____exports.MulliganVariant.MULLIGOON = 1
 ____exports.MulliganVariant[____exports.MulliganVariant.MULLIGOON] = "MULLIGOON"
@@ -12533,6 +12533,8 @@ local ____exports = {}
 -- 
 -- The `gridspawn` console command accepts `GridEntityXMLType` instead of `GridEntityType`.
 ____exports.GridEntityXMLType = {}
+____exports.GridEntityXMLType.DECORATION = 0
+____exports.GridEntityXMLType[____exports.GridEntityXMLType.DECORATION] = "DECORATION"
 ____exports.GridEntityXMLType.ROCK = 1000
 ____exports.GridEntityXMLType[____exports.GridEntityXMLType.ROCK] = "ROCK"
 ____exports.GridEntityXMLType.ROCK_BOMB = 1001
@@ -41252,7 +41254,7 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
@@ -41261,6 +41263,7 @@ local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local GridEntityXMLType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityXMLType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 local PitfallVariant = ____isaac_2Dtypescript_2Ddefinitions.PitfallVariant
@@ -41284,6 +41287,8 @@ local ____entitiesSpecific = require("src.functions.entitiesSpecific")
 local getNPCs = ____entitiesSpecific.getNPCs
 local removeAllBombs = ____entitiesSpecific.removeAllBombs
 local removeAllPickups = ____entitiesSpecific.removeAllPickups
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
 local ____gridEntities = require("src.functions.gridEntities")
 local convertXMLGridEntityType = ____gridEntities.convertXMLGridEntityType
 local getAllGridIndexes = ____gridEntities.getAllGridIndexes
@@ -41481,7 +41486,8 @@ function spawnAllEntities(self, jsonRoom, rng, verbose)
         if subType == nil then
             error("Failed to convert the entity sub-type to a number: " .. tostring(subType))
         end
-        if entityTypeNumber >= 1000 then
+        local isGridEntity = GRID_ENTITY_XML_TYPE_SET:has(entityTypeNumber)
+        if isGridEntity then
             local gridEntityXMLType = entityTypeNumber
             if verbose then
                 log(
@@ -41705,6 +41711,8 @@ end
 FEATURE_NAME = "deployJSONRoom"
 NPC_TYPES_TO_NOT_REMOVE = __TS__New(Set, {EntityType.DARK_ESAU})
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
+local gridEntityXMLTypes = getEnumValues(nil, GridEntityXMLType)
+GRID_ENTITY_XML_TYPE_SET = __TS__New(Set, gridEntityXMLTypes)
 v = {
     level = {
         deployedRoomListIndexes = __TS__New(Set),
@@ -42027,16 +42035,15 @@ function ____exports.getPreviousRoomDescription(self)
     error("Failed to find a room description for any rooms thus far on this run.")
 end
 function ____exports.getLatestRoomDescription(self)
-    local latestRoomDescription = getLastElement(nil, v.run.roomHistory)
-    if latestRoomDescription == nil then
-        error("Failed to get the latest room description since the room history array was empty.")
-    end
-    return latestRoomDescription
+    return getLastElement(nil, v.run.roomHistory)
 end
 function ____exports.isLeavingRoom(self)
     local roomListIndex = getRoomListIndex(nil)
     local roomVisitedCount = getRoomVisitedCount(nil)
     local latestRoomDescription = ____exports.getLatestRoomDescription(nil)
+    if latestRoomDescription == nil then
+        return false
+    end
     return roomListIndex ~= latestRoomDescription.roomListIndex or roomVisitedCount ~= latestRoomDescription.roomVisitedCount
 end
 return ____exports
@@ -42081,6 +42088,9 @@ function checkDespawningFromPlayerLeavingRoom(self, entity)
 end
 function trackDespawningPickupPosition(self, entity, index)
     local previousRoomDescription = getLatestRoomDescription(nil)
+    if previousRoomDescription == nil then
+        return
+    end
     local previousRoomListIndex = previousRoomDescription.roomListIndex
     local persistentEntityDescription = {
         entityType = entity.Type,
@@ -42098,7 +42108,7 @@ function postNewRoomReordered(self)
         local description = ____value[2]
         do
             if roomListIndex ~= description.roomListIndex then
-                goto __continue9
+                goto __continue10
             end
             v.level.persistentEntities:delete(index)
             spawnAndTrack(
@@ -42111,7 +42121,7 @@ function postNewRoomReordered(self)
                 true
             )
         end
-        ::__continue9::
+        ::__continue10::
     end
 end
 function spawnAndTrack(self, entityType, variant, subType, position, index, respawning)
@@ -42172,14 +42182,14 @@ function ____exports.removePersistentEntity(self, persistentEntityIndex, removeE
         do
             local index, entityPtr = table.unpack(tuple)
             if index ~= persistentEntityIndex then
-                goto __continue16
+                goto __continue17
             end
             v.room.spawnedPersistentEntities:delete(ptrHash)
             if removeEntity and entityPtr.Ref ~= nil then
                 entityPtr.Ref:Remove()
             end
         end
-        ::__continue16::
+        ::__continue17::
     end
 end
 return ____exports
@@ -42253,6 +42263,9 @@ function checkDespawningFromPlayerLeavingRoom(self, entity)
 end
 function trackDespawningPickupMetadata(self, entity, pickupIndex)
     local previousRoomDescription = getLatestRoomDescription(nil)
+    if previousRoomDescription == nil then
+        return
+    end
     local previousRoomListIndex = previousRoomDescription.roomListIndex
     local pickupDescriptions = v.level.pickupData:getAndSetDefault(previousRoomListIndex)
     local pickupDescription = {position = entity.Position, initSeed = entity.InitSeed}
@@ -42263,16 +42276,16 @@ function trackDespawningPickupMetadata(self, entity, pickupIndex)
     local room = game:GetRoom()
     local roomType = room:GetType()
     repeat
-        local ____switch13 = roomType
-        local ____cond13 = ____switch13 == RoomType.TREASURE
-        if ____cond13 then
+        local ____switch14 = roomType
+        local ____cond14 = ____switch14 == RoomType.TREASURE
+        if ____cond14 then
             do
                 v.run.pickupDataTreasureRooms:set(pickupIndex, pickupDescription)
                 break
             end
         end
-        ____cond13 = ____cond13 or ____switch13 == RoomType.BOSS
-        if ____cond13 then
+        ____cond14 = ____cond14 or ____switch14 == RoomType.BOSS
+        if ____cond14 then
             do
                 v.run.pickupDataBossRooms:set(pickupIndex, pickupDescription)
                 break
@@ -42324,15 +42337,15 @@ function getPostAscentPickupIndex(self, pickup)
     local room = game:GetRoom()
     local roomType = room:GetType()
     repeat
-        local ____switch29 = roomType
-        local ____cond29 = ____switch29 == RoomType.TREASURE
-        if ____cond29 then
+        local ____switch30 = roomType
+        local ____cond30 = ____switch30 == RoomType.TREASURE
+        if ____cond30 then
             do
                 return getStoredPickupIndex(nil, pickup, v.run.pickupDataTreasureRooms)
             end
         end
-        ____cond29 = ____cond29 or ____switch29 == RoomType.BOSS
-        if ____cond29 then
+        ____cond30 = ____cond30 or ____switch30 == RoomType.BOSS
+        if ____cond30 then
             do
                 return getStoredPickupIndex(nil, pickup, v.run.pickupDataBossRooms)
             end
@@ -42788,6 +42801,10 @@ local ____array = require("src.functions.array")
 local sumArray = ____array.sumArray
 local ____string = require("src.functions.string")
 local getPartialMatch = ____string.getPartialMatch
+function ____exports.mapSetHash(self, map, entity, value)
+    local hash = GetPtrHash(entity)
+    map:set(hash, value)
+end
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
     for ____, ____value in __TS__Iterator(oldMap:entries()) do
@@ -42797,6 +42814,13 @@ function ____exports.copyMap(self, oldMap)
     end
     return newMap
 end
+function ____exports.defaultMapGetHash(self, map, entity, ...)
+    local ptrHash = GetPtrHash(entity)
+    return map:getAndSetDefault(ptrHash, ...)
+end
+function ____exports.defaultMapSetHash(self, map, entity, value)
+    ____exports.mapSetHash(nil, map, entity, value)
+end
 function ____exports.getMapPartialMatch(self, searchText, map)
     local keys = {__TS__Spread(map:keys())}
     local matchingKey = getPartialMatch(nil, searchText, keys)

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

@@ -1 +1 @@
-{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAuDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAuKvD;;;;;;;;;;;;;;;;;;;;;;;;;;;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,GAAG,SAAS,QAAQ,EAAE,EAC3C,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAwB5D"}
+{"version":3,"file":"deployJSONRoom.d.ts","sourceRoot":"","sources":["../../../src/features/deployJSONRoom.ts"],"names":[],"mappings":";;AAwDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AA4KvD;;;;;;;;;;;;;;;;;;;;;;;;;;;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,GAAG,SAAS,QAAQ,EAAE,EAC3C,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAwB5D"}

package/dist/src/features/deployJSONRoom.lua

@@ -4,7 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
@@ -13,6 +13,7 @@ local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local GridEntityXMLType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityXMLType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 local PitfallVariant = ____isaac_2Dtypescript_2Ddefinitions.PitfallVariant
@@ -36,6 +37,8 @@ local ____entitiesSpecific = require("src.functions.entitiesSpecific")
 local getNPCs = ____entitiesSpecific.getNPCs
 local removeAllBombs = ____entitiesSpecific.removeAllBombs
 local removeAllPickups = ____entitiesSpecific.removeAllPickups
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
 local ____gridEntities = require("src.functions.gridEntities")
 local convertXMLGridEntityType = ____gridEntities.convertXMLGridEntityType
 local getAllGridIndexes = ____gridEntities.getAllGridIndexes
@@ -241,7 +244,8 @@ function spawnAllEntities(self, jsonRoom, rng, verbose)
         if subType == nil then
             error("Failed to convert the entity sub-type to a number: " .. tostring(subType))
         end
-        if entityTypeNumber >= 1000 then
+        local isGridEntity = GRID_ENTITY_XML_TYPE_SET:has(entityTypeNumber)
+        if isGridEntity then
             local gridEntityXMLType = entityTypeNumber
             if verbose then
                 log(
@@ -465,6 +469,8 @@ end
 FEATURE_NAME = "deployJSONRoom"
 NPC_TYPES_TO_NOT_REMOVE = __TS__New(Set, {EntityType.DARK_ESAU})
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
+local gridEntityXMLTypes = getEnumValues(nil, GridEntityXMLType)
+GRID_ENTITY_XML_TYPE_SET = __TS__New(Set, gridEntityXMLTypes)
 v = {
     level = {
         deployedRoomListIndexes = __TS__New(Set),

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

@@ -1 +1 @@
-{"version":3,"file":"persistentEntities.d.ts","sourceRoot":"","sources":["../../../src/features/persistentEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAgHtC;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,GACf,CAAC,MAAM,EAAE,GAAG,CAAC,CAcf;AAwBD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,qBAAqB,EAAE,GAAG,EAC1B,YAAY,UAAO,GAClB,IAAI,CAiBN"}
+{"version":3,"file":"persistentEntities.d.ts","sourceRoot":"","sources":["../../../src/features/persistentEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EAEX,MAAM,8BAA8B,CAAC;AAoHtC;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,GACf,CAAC,MAAM,EAAE,GAAG,CAAC,CAcf;AAwBD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,qBAAqB,EAAE,GAAG,EAC1B,YAAY,UAAO,GAClB,IAAI,CAiBN"}

package/dist/src/features/persistentEntities.lua

@@ -37,6 +37,9 @@ function checkDespawningFromPlayerLeavingRoom(self, entity)
 end
 function trackDespawningPickupPosition(self, entity, index)
     local previousRoomDescription = getLatestRoomDescription(nil)
+    if previousRoomDescription == nil then
+        return
+    end
     local previousRoomListIndex = previousRoomDescription.roomListIndex
     local persistentEntityDescription = {
         entityType = entity.Type,
@@ -54,7 +57,7 @@ function postNewRoomReordered(self)
         local description = ____value[2]
         do
             if roomListIndex ~= description.roomListIndex then
-                goto __continue9
+                goto __continue10
             end
             v.level.persistentEntities:delete(index)
             spawnAndTrack(
@@ -67,7 +70,7 @@ function postNewRoomReordered(self)
                 true
             )
         end
-        ::__continue9::
+        ::__continue10::
     end
 end
 function spawnAndTrack(self, entityType, variant, subType, position, index, respawning)
@@ -152,14 +155,14 @@ function ____exports.removePersistentEntity(self, persistentEntityIndex, removeE
         do
             local index, entityPtr = table.unpack(tuple)
             if index ~= persistentEntityIndex then
-                goto __continue16
+                goto __continue17
             end
             v.room.spawnedPersistentEntities:delete(ptrHash)
             if removeEntity and entityPtr.Ref ~= nil then
                 entityPtr.Ref:Remove()
             end
         end
-        ::__continue16::
+        ::__continue17::
     end
 end
 return ____exports

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

@@ -1 +1 @@
-{"version":3,"file":"pickupIndex.d.ts","sourceRoot":"","sources":["../../../src/features/pickupIndex.ts"],"names":[],"mappings":";AAeA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAkNnD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW,CAahE"}
+{"version":3,"file":"pickupIndex.d.ts","sourceRoot":"","sources":["../../../src/features/pickupIndex.ts"],"names":[],"mappings":";AAeA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAsNnD;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,WAAW,CAahE"}

package/dist/src/features/pickupIndex.lua

@@ -62,6 +62,9 @@ function checkDespawningFromPlayerLeavingRoom(self, entity)
 end
 function trackDespawningPickupMetadata(self, entity, pickupIndex)
     local previousRoomDescription = getLatestRoomDescription(nil)
+    if previousRoomDescription == nil then
+        return
+    end
     local previousRoomListIndex = previousRoomDescription.roomListIndex
     local pickupDescriptions = v.level.pickupData:getAndSetDefault(previousRoomListIndex)
     local pickupDescription = {position = entity.Position, initSeed = entity.InitSeed}
@@ -72,16 +75,16 @@ function trackDespawningPickupMetadata(self, entity, pickupIndex)
     local room = game:GetRoom()
     local roomType = room:GetType()
     repeat
-        local ____switch13 = roomType
-        local ____cond13 = ____switch13 == RoomType.TREASURE
-        if ____cond13 then
+        local ____switch14 = roomType
+        local ____cond14 = ____switch14 == RoomType.TREASURE
+        if ____cond14 then
             do
                 v.run.pickupDataTreasureRooms:set(pickupIndex, pickupDescription)
                 break
             end
         end
-        ____cond13 = ____cond13 or ____switch13 == RoomType.BOSS
-        if ____cond13 then
+        ____cond14 = ____cond14 or ____switch14 == RoomType.BOSS
+        if ____cond14 then
             do
                 v.run.pickupDataBossRooms:set(pickupIndex, pickupDescription)
                 break
@@ -133,15 +136,15 @@ function getPostAscentPickupIndex(self, pickup)
     local room = game:GetRoom()
     local roomType = room:GetType()
     repeat
-        local ____switch29 = roomType
-        local ____cond29 = ____switch29 == RoomType.TREASURE
-        if ____cond29 then
+        local ____switch30 = roomType
+        local ____cond30 = ____switch30 == RoomType.TREASURE
+        if ____cond30 then
             do
                 return getStoredPickupIndex(nil, pickup, v.run.pickupDataTreasureRooms)
             end
         end
-        ____cond29 = ____cond29 or ____switch29 == RoomType.BOSS
-        if ____cond29 then
+        ____cond30 = ____cond30 or ____switch30 == RoomType.BOSS
+        if ____cond30 then
             do
                 return getStoredPickupIndex(nil, pickup, v.run.pickupDataBossRooms)
             end

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

@@ -16,8 +16,11 @@ export declare function getPreviousRoomDescription(): RoomDescription;
  * 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.
  */
-export declare function getLatestRoomDescription(): RoomDescription;
+export declare function getLatestRoomDescription(): 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
@@ -25,7 +28,7 @@ export declare function getLatestRoomDescription(): RoomDescription;
  * 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 pseudo-persistent entity such as a pickup is despawning.
+ * entity is despawning.
  */
 export declare function isLeavingRoom(): boolean;
 //# sourceMappingURL=roomHistory.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"roomHistory.d.ts","sourceRoot":"","sources":["../../../src/features/roomHistory.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAmDhE;;;GAGG;AACH,wBAAgB,cAAc,IAAI,SAAS,eAAe,EAAE,CAG3D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,eAAe,CAe5D;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,eAAe,CAS1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,IAAI,OAAO,CASvC"}
+{"version":3,"file":"roomHistory.d.ts","sourceRoot":"","sources":["../../../src/features/roomHistory.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAmDhE;;;GAGG;AACH,wBAAgB,cAAc,IAAI,SAAS,eAAe,EAAE,CAG3D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,eAAe,CAe5D;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,IAAI,eAAe,GAAG,SAAS,CAEtE;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAevC"}

package/dist/src/features/roomHistory.lua

@@ -79,12 +79,11 @@ end
 -- 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.
 function ____exports.getLatestRoomDescription(self)
-    local latestRoomDescription = getLastElement(nil, v.run.roomHistory)
-    if latestRoomDescription == nil then
-        error("Failed to get the latest room description since the room history array was empty.")
-    end
-    return latestRoomDescription
+    return getLastElement(nil, v.run.roomHistory)
 end
 --- 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
@@ -92,11 +91,14 @@ end
 -- 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 pseudo-persistent entity such as a pickup is despawning.
+-- entity is despawning.
 function ____exports.isLeavingRoom(self)
     local roomListIndex = getRoomListIndex(nil)
     local roomVisitedCount = getRoomVisitedCount(nil)
     local latestRoomDescription = ____exports.getLatestRoomDescription(nil)
+    if latestRoomDescription == nil then
+        return false
+    end
     return roomListIndex ~= latestRoomDescription.roomListIndex or roomVisitedCount ~= latestRoomDescription.roomVisitedCount
 end
 return ____exports

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

@@ -1,5 +1,21 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+import { DefaultMap } from "../classes/DefaultMap";
 /** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
 export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
+/**
+ * Helper function to get the value from a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export declare function defaultMapGetHash<V, A extends unknown[]>(map: DefaultMap<PtrHash, V, A>, entity: Entity, ...extraArgs: A): V;
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ *
+ * Since `Map` and `DefaultMap` set values in the same way, this function is simply an alias for the
+ * `mapSetHash` helper function.
+ */
+export declare function defaultMapSetHash<V>(map: Map<PtrHash, V>, entity: Entity, value: V): void;
 /**
  * Helper function to get the closest value from a map based on partial search text. For the
  * purposes of this function, both search text and map keys are converted to lowercase before
@@ -20,6 +36,11 @@ export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
  * ```
  */
 export declare function getMapPartialMatch<T>(searchText: string, map: ReadonlyMap<string, T>): [string, T] | undefined;
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export declare function mapSetHash<V>(map: Map<PtrHash, V>, entity: Entity, value: V): void;
 /** Helper function to sum every value in a map together. */
 export declare function sumMap(map: Map<unknown, number> | ReadonlyMap<unknown, number>): number;
 //# sourceMappingURL=map.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../../src/functions/map.ts"],"names":[],"mappings":"AAGA,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAO1D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAgBzB;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR"}
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../../src/functions/map.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAInD,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAO1D;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EACtD,GAAG,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,EAC9B,MAAM,EAAE,MAAM,EACd,GAAG,SAAS,EAAE,CAAC,GACd,CAAC,CAGH;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACP,IAAI,CAEN;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAgBzB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,GACP,IAAI,CAGN;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR"}

package/dist/src/functions/map.lua

@@ -8,6 +8,12 @@ local ____array = require("src.functions.array")
 local sumArray = ____array.sumArray
 local ____string = require("src.functions.string")
 local getPartialMatch = ____string.getPartialMatch
+--- Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+-- the map uses `PtrHash` as an index.
+function ____exports.mapSetHash(self, map, entity, value)
+    local hash = GetPtrHash(entity)
+    map:set(hash, value)
+end
 --- Helper function to copy a map. (You can also use a Map constructor to accomplish this task.)
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
@@ -18,6 +24,20 @@ function ____exports.copyMap(self, oldMap)
     end
     return newMap
 end
+--- Helper function to get the value from a `DefaultMap` that corresponds to an entity, assuming that
+-- the map uses `PtrHash` as an index.
+function ____exports.defaultMapGetHash(self, map, entity, ...)
+    local ptrHash = GetPtrHash(entity)
+    return map:getAndSetDefault(ptrHash, ...)
+end
+--- Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+-- the map uses `PtrHash` as an index.
+-- 
+-- Since `Map` and `DefaultMap` set values in the same way, this function is simply an alias for the
+-- `mapSetHash` helper function.
+function ____exports.defaultMapSetHash(self, map, entity, value)
+    ____exports.mapSetHash(nil, map, entity, value)
+end
 --- Helper function to get the closest value from a map based on partial search text. For the
 -- purposes of this function, both search text and map keys are converted to lowercase before
 -- attempting to find a match.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "12.5.0",
+  "version": "12.5.2",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^7.2.5"
+    "isaac-typescript-definitions": "^7.2.6"
   }
 }

package/src/features/deployJSONRoom.ts

@@ -36,6 +36,7 @@ import {
   removeAllBombs,
   removeAllPickups,
 } from "../functions/entitiesSpecific";
+import { getEnumValues } from "../functions/enums";
 import {
   convertXMLGridEntityType,
   getAllGridIndexes,
@@ -74,6 +75,11 @@ const PERSISTENT_ENTITY_TYPES: ReadonlySet<EntityType> = new Set([
   EntityType.WALL_HUGGER,
 ]);
 
+const gridEntityXMLTypes = getEnumValues(GridEntityXMLType);
+const GRID_ENTITY_XML_TYPE_SET: ReadonlySet<number> = new Set(
+  gridEntityXMLTypes,
+);
+
 const v = {
   level: {
     deployedRoomListIndexes: new Set<int>(),
@@ -492,8 +498,8 @@ function spawnAllEntities(
       error(`Failed to convert the entity sub-type to a number: ${subType}`);
     }
 
-    // Note that XML entity type 1000 is a rock, not an effect.
-    if (entityTypeNumber >= 1000) {
+    const isGridEntity = GRID_ENTITY_XML_TYPE_SET.has(entityTypeNumber);
+    if (isGridEntity) {
       const gridEntityXMLType = entityTypeNumber as GridEntityXMLType;
       if (verbose) {
         log(

package/src/features/persistentEntities.ts

@@ -82,6 +82,10 @@ function trackDespawningPickupPosition(entity: Entity, index: int) {
   // (The "latest" room description is really the previous room, because the `POST_NEW_ROOM`
   // callback was not fired yet.)
   const previousRoomDescription = getLatestRoomDescription();
+  if (previousRoomDescription === undefined) {
+    return;
+  }
+
   const previousRoomListIndex = previousRoomDescription.roomListIndex;
   const persistentEntityDescription: PersistentEntityDescription = {
     entityType: entity.Type,

package/src/features/pickupIndex.ts

@@ -114,6 +114,10 @@ function trackDespawningPickupMetadata(
   // The "latest" room description is really the previous room, because the `POST_NEW_ROOM` callback
   // was not fired yet.
   const previousRoomDescription = getLatestRoomDescription();
+  if (previousRoomDescription === undefined) {
+    return;
+  }
+
   const previousRoomListIndex = previousRoomDescription.roomListIndex;
   const pickupDescriptions = v.level.pickupData.getAndSetDefault(
     previousRoomListIndex,

package/src/features/roomHistory.ts

@@ -100,16 +100,12 @@ export function getPreviousRoomDescription(): RoomDescription {
  * 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.
  */
-export function getLatestRoomDescription(): RoomDescription {
-  const latestRoomDescription = getLastElement(v.run.roomHistory);
-  if (latestRoomDescription === undefined) {
-    error(
-      "Failed to get the latest room description since the room history array was empty.",
-    );
-  }
-
-  return latestRoomDescription;
+export function getLatestRoomDescription(): RoomDescription | undefined {
+  return getLastElement(v.run.roomHistory);
 }
 
 /**
@@ -119,13 +115,19 @@ export function getLatestRoomDescription(): RoomDescription {
  * 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 pseudo-persistent entity such as a pickup is despawning.
+ * entity is despawning.
  */
 export function isLeavingRoom(): boolean {
   const roomListIndex = getRoomListIndex();
   const roomVisitedCount = getRoomVisitedCount();
   const latestRoomDescription = getLatestRoomDescription();
 
+  // Sometimes, this function can be called in situations where entities from the previous run are
+  // being despawned. If this is the case, then the room history will currently be empty.
+  if (latestRoomDescription === undefined) {
+    return false;
+  }
+
   return (
     roomListIndex !== latestRoomDescription.roomListIndex ||
     roomVisitedCount !== latestRoomDescription.roomVisitedCount

package/src/functions/map.ts

@@ -1,3 +1,4 @@
+import { DefaultMap } from "../classes/DefaultMap";
 import { sumArray } from "./array";
 import { getPartialMatch } from "./string";
 
@@ -11,6 +12,34 @@ export function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V> {
   return newMap;
 }
 
+/**
+ * Helper function to get the value from a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export function defaultMapGetHash<V, A extends unknown[]>(
+  map: DefaultMap<PtrHash, V, A>,
+  entity: Entity,
+  ...extraArgs: A
+): V {
+  const ptrHash = GetPtrHash(entity);
+  return map.getAndSetDefault(ptrHash, ...extraArgs);
+}
+
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ *
+ * Since `Map` and `DefaultMap` set values in the same way, this function is simply an alias for the
+ * `mapSetHash` helper function.
+ */
+export function defaultMapSetHash<V>(
+  map: Map<PtrHash, V>,
+  entity: Entity,
+  value: V,
+): void {
+  mapSetHash(map, entity, value);
+}
+
 /**
  * Helper function to get the closest value from a map based on partial search text. For the
  * purposes of this function, both search text and map keys are converted to lowercase before
@@ -51,6 +80,19 @@ export function getMapPartialMatch<T>(
   return [matchingKey, value];
 }
 
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export function mapSetHash<V>(
+  map: Map<PtrHash, V>,
+  entity: Entity,
+  value: V,
+): void {
+  const hash = GetPtrHash(entity);
+  map.set(hash, value);
+}
+
 /** Helper function to sum every value in a map together. */
 export function sumMap(
   map: Map<unknown, number> | ReadonlyMap<unknown, number>,