isaacscript-common 12.5.0 → 12.5.1

package/dist/index.d.ts

@@ -3603,8 +3603,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 +6178,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;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 12.5.0
+isaacscript-common 12.5.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -42027,16 +42027,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 +42080,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 +42100,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 +42113,7 @@ function postNewRoomReordered(self)
                 true
             )
         end
-        ::__continue9::
+        ::__continue10::
     end
 end
 function spawnAndTrack(self, entityType, variant, subType, position, index, respawning)
@@ -42172,14 +42174,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 +42255,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 +42268,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 +42329,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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "12.5.0",
+  "version": "12.5.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

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