isaacscript-common 12.4.0 → 12.5.1

package/dist/index.d.ts

@@ -3424,7 +3424,7 @@ export declare function getHorsePillColors(): PillColor[];
  *
  * For example:
  * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
- * - If the user has a HUD offset of 1.0 configured, this function will return 10
+ * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
  */
 export declare function getHUDOffsetVector(): Vector;
 
@@ -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
@@ -5409,6 +5412,14 @@ export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomS
  */
 export declare function gridPositionToWorldPosition(gridPosition: Vector): Vector;
 
+/**
+ * Helper function to see if a particular entity has armor. In this context, armor refers to the
+ * damage scaling mechanic. For example, Ultra Greed has armor, but a Gaper does not.
+ *
+ * For more on armor, see the wiki: https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling
+ */
+export declare function hasArmor(entity: Entity): boolean;
+
 export declare function hasCurse(curse: LevelCurse): boolean;
 
 /**
@@ -6167,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.4.0
+isaacscript-common 12.5.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19289,6 +19289,81 @@ return ____exports
  end,
 ["src.types.AnyGridEntity"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.sets.entitiesWithArmorSet"] = function(...) 
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local BeastVariant = ____isaac_2Dtypescript_2Ddefinitions.BeastVariant
+local BloodPuppyVariant = ____isaac_2Dtypescript_2Ddefinitions.BloodPuppyVariant
+local BoomFlyVariant = ____isaac_2Dtypescript_2Ddefinitions.BoomFlyVariant
+local Charger2Variant = ____isaac_2Dtypescript_2Ddefinitions.Charger2Variant
+local DogmaVariant = ____isaac_2Dtypescript_2Ddefinitions.DogmaVariant
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local FacelessVariant = ____isaac_2Dtypescript_2Ddefinitions.FacelessVariant
+local Gaper2Variant = ____isaac_2Dtypescript_2Ddefinitions.Gaper2Variant
+local GuttyFattyVariant = ____isaac_2Dtypescript_2Ddefinitions.GuttyFattyVariant
+local HiveVariant = ____isaac_2Dtypescript_2Ddefinitions.HiveVariant
+local HopperVariant = ____isaac_2Dtypescript_2Ddefinitions.HopperVariant
+local IsaacVariant = ____isaac_2Dtypescript_2Ddefinitions.IsaacVariant
+local MegaSatanVariant = ____isaac_2Dtypescript_2Ddefinitions.MegaSatanVariant
+local MoleVariant = ____isaac_2Dtypescript_2Ddefinitions.MoleVariant
+local MotherVariant = ____isaac_2Dtypescript_2Ddefinitions.MotherVariant
+local PooterVariant = ____isaac_2Dtypescript_2Ddefinitions.PooterVariant
+local RoundWormVariant = ____isaac_2Dtypescript_2Ddefinitions.RoundWormVariant
+local SubHorfVariant = ____isaac_2Dtypescript_2Ddefinitions.SubHorfVariant
+local SuckerVariant = ____isaac_2Dtypescript_2Ddefinitions.SuckerVariant
+local UltraGreedVariant = ____isaac_2Dtypescript_2Ddefinitions.UltraGreedVariant
+local WallCreepVariant = ____isaac_2Dtypescript_2Ddefinitions.WallCreepVariant
+____exports.ENTITIES_WITH_ARMOR_SET = __TS__New(
+    Set,
+    {
+        (tostring(EntityType.POOTER) .. ".") .. tostring(PooterVariant.TAINTED_POOTER),
+        (tostring(EntityType.HIVE) .. ".") .. tostring(HiveVariant.TAINTED_MULLIGAN),
+        (tostring(EntityType.BOOM_FLY) .. ".") .. tostring(BoomFlyVariant.TAINTED_BOOM_FLY),
+        (tostring(EntityType.HOPPER) .. ".") .. tostring(HopperVariant.TAINTED_HOPPER),
+        tostring(EntityType.SPITTY),
+        (tostring(EntityType.SUCKER) .. ".") .. tostring(SuckerVariant.TAINTED_SUCKER),
+        (tostring(EntityType.ISAAC) .. ".") .. tostring(IsaacVariant.BLUE_BABY_HUSH),
+        (tostring(EntityType.WALL_CREEP) .. ".") .. tostring(WallCreepVariant.TAINTED_SOY_CREEP),
+        (tostring(EntityType.ROUND_WORM) .. ".") .. tostring(RoundWormVariant.TAINTED_ROUND_WORM),
+        (tostring(EntityType.ROUND_WORM) .. ".") .. tostring(RoundWormVariant.TAINTED_TUBE_WORM),
+        (tostring(EntityType.MEGA_SATAN) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN),
+        (tostring(EntityType.MEGA_SATAN) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_RIGHT_HAND),
+        (tostring(EntityType.MEGA_SATAN) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_LEFT_HAND),
+        (tostring(EntityType.MEGA_SATAN_2) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN),
+        (tostring(EntityType.MEGA_SATAN_2) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_RIGHT_HAND),
+        (tostring(EntityType.MEGA_SATAN_2) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_LEFT_HAND),
+        (tostring(EntityType.ULTRA_GREED) .. ".") .. tostring(UltraGreedVariant.ULTRA_GREED),
+        (tostring(EntityType.ULTRA_GREED) .. ".") .. tostring(UltraGreedVariant.ULTRA_GREEDIER),
+        tostring(EntityType.HUSH) .. ".0",
+        tostring(EntityType.DELIRIUM) .. ".0",
+        (tostring(EntityType.BLOOD_PUPPY) .. ".") .. tostring(BloodPuppyVariant.SMALL),
+        (tostring(EntityType.BLOOD_PUPPY) .. ".") .. tostring(BloodPuppyVariant.LARGE),
+        (tostring(EntityType.SUB_HORF) .. ".") .. tostring(SubHorfVariant.TAINTED_SUB_HORF),
+        (tostring(EntityType.FACELESS) .. ".") .. tostring(FacelessVariant.TAINTED_FACELESS),
+        (tostring(EntityType.MOLE) .. ".") .. tostring(MoleVariant.TAINTED_MOLE),
+        (tostring(EntityType.GUTTED_FATTY) .. ".") .. tostring(GuttyFattyVariant.GUTTED_FATTY),
+        (tostring(EntityType.GAPER_L2) .. ".") .. tostring(Gaper2Variant.GAPER),
+        (tostring(EntityType.GAPER_L2) .. ".") .. tostring(Gaper2Variant.HORF),
+        (tostring(EntityType.GAPER_L2) .. ".") .. tostring(Gaper2Variant.GUSHER),
+        (tostring(EntityType.CHARGER_L2) .. ".") .. tostring(Charger2Variant.CHARGER),
+        (tostring(EntityType.CHARGER_L2) .. ".") .. tostring(Charger2Variant.ELLEECH),
+        tostring(EntityType.SHADY) .. ".0",
+        (tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_1),
+        (tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_2),
+        (tostring(EntityType.DOGMA) .. ".") .. tostring(DogmaVariant.TV),
+        (tostring(EntityType.DOGMA) .. ".") .. tostring(DogmaVariant.ANGEL_PHASE_2),
+        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.BEAST),
+        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_FAMINE),
+        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_PESTILENCE),
+        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_WAR),
+        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_DEATH)
+    }
+)
 return ____exports
  end,
 ["src.sets.storyBossesSet"] = function(...) 
@@ -19499,8 +19574,8 @@ return ____exports
  end,
 ["src.functions.entities"] = function(...) 
 local ____lualib = require("lualib_bundle")
-local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local Set = ____lualib.Set
+local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__StringSplit = ____lualib.__TS__StringSplit
@@ -19510,6 +19585,8 @@ local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("src.core.constants")
 local VectorZero = ____constants.VectorZero
+local ____entitiesWithArmorSet = require("src.sets.entitiesWithArmorSet")
+local ENTITIES_WITH_ARMOR_SET = ____entitiesWithArmorSet.ENTITIES_WITH_ARMOR_SET
 local ____storyBossesSet = require("src.sets.storyBossesSet")
 local STORY_BOSSES_SET = ____storyBossesSet.STORY_BOSSES_SET
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
@@ -19685,6 +19762,10 @@ function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
         end
     )
 end
+function ____exports.hasArmor(self, entity)
+    local typeVariantString = (tostring(entity.Type) .. ".") .. tostring(entity.Variant)
+    return ENTITIES_WITH_ARMOR_SET:has(typeVariantString)
+end
 function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01
@@ -41946,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
@@ -42000,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,
@@ -42017,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(
@@ -42030,7 +42113,7 @@ function postNewRoomReordered(self)
                 true
             )
         end
-        ::__continue9::
+        ::__continue10::
     end
 end
 function spawnAndTrack(self, entityType, variant, subType, position, index, respawning)
@@ -42091,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
@@ -42172,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}
@@ -42182,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
@@ -42243,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
@@ -52207,40 +52293,6 @@ do
         end
     end
 end
-return ____exports
- end,
-["src.sets.entitiesWithArmorSet"] = function(...) 
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
-local BeastVariant = ____isaac_2Dtypescript_2Ddefinitions.BeastVariant
-local BoomFlyVariant = ____isaac_2Dtypescript_2Ddefinitions.BoomFlyVariant
-local DogmaVariant = ____isaac_2Dtypescript_2Ddefinitions.DogmaVariant
-local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
-local HiveVariant = ____isaac_2Dtypescript_2Ddefinitions.HiveVariant
-local HopperVariant = ____isaac_2Dtypescript_2Ddefinitions.HopperVariant
-local MotherVariant = ____isaac_2Dtypescript_2Ddefinitions.MotherVariant
-local PooterVariant = ____isaac_2Dtypescript_2Ddefinitions.PooterVariant
-____exports.ENTITIES_WITH_ARMOR_SET = __TS__New(
-    Set,
-    {
-        (tostring(EntityType.POOTER) .. ".") .. tostring(PooterVariant.TAINTED_POOTER),
-        (tostring(EntityType.HIVE) .. ".") .. tostring(HiveVariant.TAINTED_MULLIGAN),
-        (tostring(EntityType.BOOM_FLY) .. ".") .. tostring(BoomFlyVariant.TAINTED_BOOM_FLY),
-        (tostring(EntityType.HOPPER) .. ".") .. tostring(HopperVariant.TAINTED_HOPPER),
-        tostring(EntityType.SPITTY),
-        (tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_1),
-        (tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_2),
-        (tostring(EntityType.DOGMA) .. ".") .. tostring(DogmaVariant.DOGMA_PHASE_1),
-        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.BEAST),
-        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_FAMINE),
-        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_PESTILENCE),
-        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_WAR),
-        (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_DEATH)
-    }
-)
 return ____exports
  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/dist/src/functions/entities.d.ts

@@ -88,6 +88,13 @@ export declare function getEntityIDFromConstituents(entityType: EntityType, vari
  * second array but not in the first array.
  */
 export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities: T[], newEntities: T[]): T[];
+/**
+ * Helper function to see if a particular entity has armor. In this context, armor refers to the
+ * damage scaling mechanic. For example, Ultra Greed has armor, but a Gaper does not.
+ *
+ * For more on armor, see the wiki: https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling
+ */
+export declare function hasArmor(entity: Entity): boolean;
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAkB/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAGzE;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAK1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAkB/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAGzE;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGhD;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}

package/dist/src/functions/entities.lua

@@ -1,6 +1,6 @@
 local ____lualib = require("lualib_bundle")
-local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local Set = ____lualib.Set
+local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__StringSplit = ____lualib.__TS__StringSplit
@@ -10,6 +10,8 @@ local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("src.core.constants")
 local VectorZero = ____constants.VectorZero
+local ____entitiesWithArmorSet = require("src.sets.entitiesWithArmorSet")
+local ENTITIES_WITH_ARMOR_SET = ____entitiesWithArmorSet.ENTITIES_WITH_ARMOR_SET
 local ____storyBossesSet = require("src.sets.storyBossesSet")
 local STORY_BOSSES_SET = ____storyBossesSet.STORY_BOSSES_SET
 local ____isaacAPIClass = require("src.functions.isaacAPIClass")
@@ -253,6 +255,14 @@ function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
         end
     )
 end
+--- Helper function to see if a particular entity has armor. In this context, armor refers to the
+-- damage scaling mechanic. For example, Ultra Greed has armor, but a Gaper does not.
+-- 
+-- For more on armor, see the wiki: https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling
+function ____exports.hasArmor(self, entity)
+    local typeVariantString = (tostring(entity.Type) .. ".") .. tostring(entity.Variant)
+    return ENTITIES_WITH_ARMOR_SET:has(typeVariantString)
+end
 --- Helper function to measure an entity's velocity to see if it is moving.
 -- 
 -- Use this helper function over checking if the velocity length is equal to 0 because entities can

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

@@ -8,7 +8,7 @@
  *
  * For example:
  * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
- * - If the user has a HUD offset of 1.0 configured, this function will return 10
+ * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
  */
 export declare function getHUDOffsetVector(): Vector;
 /**

package/dist/src/functions/ui.lua

@@ -20,7 +20,7 @@ end
 -- 
 -- For example:
 -- - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
--- - If the user has a HUD offset of 1.0 configured, this function will return 10
+-- - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
 function ____exports.getHUDOffsetVector(self)
     local hudOffset = math.floor(Options.HUDOffset * 10)
     if hudOffset < 1 or hudOffset > 10 then

package/dist/src/sets/entitiesWithArmorSet.d.ts

@@ -1,8 +1,13 @@
 /**
- * Corresponds to:
+ * "Armor" refers to the damage scaling mechanic. The following list corresponds to the entities
+ * that have the "shieldStrength" field in the "entities2.xml" file, with some exceptions.
+ * (Invulnerable enemies are not included. Furthermore, Ultra Greed, Ultra Greedier, and Delirium
+ * all have damage scaling, but do not have a corresponding "shieldStrength" field.)
+ *
+ * Also see:
  * https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling#Entities_with_Armor_Values
  *
- * We use the entity ID instead of type + variant tuple so that we can have O(1) lookups.
+ * We use strings instead of a type + variant tuple so that we can have O(1) lookups.
  */
 export declare const ENTITIES_WITH_ARMOR_SET: Set<string>;
 //# sourceMappingURL=entitiesWithArmorSet.d.ts.map

package/dist/src/sets/entitiesWithArmorSet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entitiesWithArmorSet.d.ts","sourceRoot":"","sources":["../../../src/sets/entitiesWithArmorSet.ts"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,aAwClC,CAAC"}
+{"version":3,"file":"entitiesWithArmorSet.d.ts","sourceRoot":"","sources":["../../../src/sets/entitiesWithArmorSet.ts"],"names":[],"mappings":"AAwBA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,uBAAuB,aA0ClC,CAAC"}

package/dist/src/sets/entitiesWithArmorSet.lua

@@ -4,17 +4,35 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local BeastVariant = ____isaac_2Dtypescript_2Ddefinitions.BeastVariant
+local BloodPuppyVariant = ____isaac_2Dtypescript_2Ddefinitions.BloodPuppyVariant
 local BoomFlyVariant = ____isaac_2Dtypescript_2Ddefinitions.BoomFlyVariant
+local Charger2Variant = ____isaac_2Dtypescript_2Ddefinitions.Charger2Variant
 local DogmaVariant = ____isaac_2Dtypescript_2Ddefinitions.DogmaVariant
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local FacelessVariant = ____isaac_2Dtypescript_2Ddefinitions.FacelessVariant
+local Gaper2Variant = ____isaac_2Dtypescript_2Ddefinitions.Gaper2Variant
+local GuttyFattyVariant = ____isaac_2Dtypescript_2Ddefinitions.GuttyFattyVariant
 local HiveVariant = ____isaac_2Dtypescript_2Ddefinitions.HiveVariant
 local HopperVariant = ____isaac_2Dtypescript_2Ddefinitions.HopperVariant
+local IsaacVariant = ____isaac_2Dtypescript_2Ddefinitions.IsaacVariant
+local MegaSatanVariant = ____isaac_2Dtypescript_2Ddefinitions.MegaSatanVariant
+local MoleVariant = ____isaac_2Dtypescript_2Ddefinitions.MoleVariant
 local MotherVariant = ____isaac_2Dtypescript_2Ddefinitions.MotherVariant
 local PooterVariant = ____isaac_2Dtypescript_2Ddefinitions.PooterVariant
---- Corresponds to:
+local RoundWormVariant = ____isaac_2Dtypescript_2Ddefinitions.RoundWormVariant
+local SubHorfVariant = ____isaac_2Dtypescript_2Ddefinitions.SubHorfVariant
+local SuckerVariant = ____isaac_2Dtypescript_2Ddefinitions.SuckerVariant
+local UltraGreedVariant = ____isaac_2Dtypescript_2Ddefinitions.UltraGreedVariant
+local WallCreepVariant = ____isaac_2Dtypescript_2Ddefinitions.WallCreepVariant
+--- "Armor" refers to the damage scaling mechanic. The following list corresponds to the entities
+-- that have the "shieldStrength" field in the "entities2.xml" file, with some exceptions.
+-- (Invulnerable enemies are not included. Furthermore, Ultra Greed, Ultra Greedier, and Delirium
+-- all have damage scaling, but do not have a corresponding "shieldStrength" field.)
+-- 
+-- Also see:
 -- https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling#Entities_with_Armor_Values
 -- 
--- We use the entity ID instead of type + variant tuple so that we can have O(1) lookups.
+-- We use strings instead of a type + variant tuple so that we can have O(1) lookups.
 ____exports.ENTITIES_WITH_ARMOR_SET = __TS__New(
     Set,
     {
@@ -23,9 +41,37 @@ ____exports.ENTITIES_WITH_ARMOR_SET = __TS__New(
         (tostring(EntityType.BOOM_FLY) .. ".") .. tostring(BoomFlyVariant.TAINTED_BOOM_FLY),
         (tostring(EntityType.HOPPER) .. ".") .. tostring(HopperVariant.TAINTED_HOPPER),
         tostring(EntityType.SPITTY),
+        (tostring(EntityType.SUCKER) .. ".") .. tostring(SuckerVariant.TAINTED_SUCKER),
+        (tostring(EntityType.ISAAC) .. ".") .. tostring(IsaacVariant.BLUE_BABY_HUSH),
+        (tostring(EntityType.WALL_CREEP) .. ".") .. tostring(WallCreepVariant.TAINTED_SOY_CREEP),
+        (tostring(EntityType.ROUND_WORM) .. ".") .. tostring(RoundWormVariant.TAINTED_ROUND_WORM),
+        (tostring(EntityType.ROUND_WORM) .. ".") .. tostring(RoundWormVariant.TAINTED_TUBE_WORM),
+        (tostring(EntityType.MEGA_SATAN) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN),
+        (tostring(EntityType.MEGA_SATAN) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_RIGHT_HAND),
+        (tostring(EntityType.MEGA_SATAN) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_LEFT_HAND),
+        (tostring(EntityType.MEGA_SATAN_2) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN),
+        (tostring(EntityType.MEGA_SATAN_2) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_RIGHT_HAND),
+        (tostring(EntityType.MEGA_SATAN_2) .. ".") .. tostring(MegaSatanVariant.MEGA_SATAN_LEFT_HAND),
+        (tostring(EntityType.ULTRA_GREED) .. ".") .. tostring(UltraGreedVariant.ULTRA_GREED),
+        (tostring(EntityType.ULTRA_GREED) .. ".") .. tostring(UltraGreedVariant.ULTRA_GREEDIER),
+        tostring(EntityType.HUSH) .. ".0",
+        tostring(EntityType.DELIRIUM) .. ".0",
+        (tostring(EntityType.BLOOD_PUPPY) .. ".") .. tostring(BloodPuppyVariant.SMALL),
+        (tostring(EntityType.BLOOD_PUPPY) .. ".") .. tostring(BloodPuppyVariant.LARGE),
+        (tostring(EntityType.SUB_HORF) .. ".") .. tostring(SubHorfVariant.TAINTED_SUB_HORF),
+        (tostring(EntityType.FACELESS) .. ".") .. tostring(FacelessVariant.TAINTED_FACELESS),
+        (tostring(EntityType.MOLE) .. ".") .. tostring(MoleVariant.TAINTED_MOLE),
+        (tostring(EntityType.GUTTED_FATTY) .. ".") .. tostring(GuttyFattyVariant.GUTTED_FATTY),
+        (tostring(EntityType.GAPER_L2) .. ".") .. tostring(Gaper2Variant.GAPER),
+        (tostring(EntityType.GAPER_L2) .. ".") .. tostring(Gaper2Variant.HORF),
+        (tostring(EntityType.GAPER_L2) .. ".") .. tostring(Gaper2Variant.GUSHER),
+        (tostring(EntityType.CHARGER_L2) .. ".") .. tostring(Charger2Variant.CHARGER),
+        (tostring(EntityType.CHARGER_L2) .. ".") .. tostring(Charger2Variant.ELLEECH),
+        tostring(EntityType.SHADY) .. ".0",
         (tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_1),
         (tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_2),
-        (tostring(EntityType.DOGMA) .. ".") .. tostring(DogmaVariant.DOGMA_PHASE_1),
+        (tostring(EntityType.DOGMA) .. ".") .. tostring(DogmaVariant.TV),
+        (tostring(EntityType.DOGMA) .. ".") .. tostring(DogmaVariant.ANGEL_PHASE_2),
         (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.BEAST),
         (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_FAMINE),
         (tostring(EntityType.BEAST) .. ".") .. tostring(BeastVariant.ULTRA_PESTILENCE),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "12.4.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

package/src/functions/entities.ts

@@ -1,6 +1,7 @@
 import { EntityType } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { VectorZero } from "../core/constants";
+import { ENTITIES_WITH_ARMOR_SET } from "../sets/entitiesWithArmorSet";
 import { STORY_BOSSES_SET } from "../sets/storyBossesSet";
 import { AnyEntity } from "../types/AnyEntity";
 import { getIsaacAPIClassName } from "./isaacAPIClass";
@@ -251,6 +252,17 @@ export function getFilteredNewEntities<T extends AnyEntity>(
   });
 }
 
+/**
+ * Helper function to see if a particular entity has armor. In this context, armor refers to the
+ * damage scaling mechanic. For example, Ultra Greed has armor, but a Gaper does not.
+ *
+ * For more on armor, see the wiki: https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling
+ */
+export function hasArmor(entity: Entity): boolean {
+  const typeVariantString = `${entity.Type}.${entity.Variant}`;
+  return ENTITIES_WITH_ARMOR_SET.has(typeVariantString);
+}
+
 /**
  * Helper function to measure an entity's velocity to see if it is moving.
  *

package/src/functions/ui.ts

@@ -10,7 +10,7 @@ import { copyVector } from "./vector";
  *
  * For example:
  * - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
- * - If the user has a HUD offset of 1.0 configured, this function will return 10
+ * - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
  */
 export function getHUDOffsetVector(): Vector {
   // Convert e.g. 0.4 to 4.

package/src/sets/entitiesWithArmorSet.ts

@@ -1,55 +1,75 @@
 import {
   BeastVariant,
+  BloodPuppyVariant,
   BoomFlyVariant,
+  Charger2Variant,
   DogmaVariant,
   EntityType,
+  FacelessVariant,
+  Gaper2Variant,
+  GuttyFattyVariant,
   HiveVariant,
   HopperVariant,
+  IsaacVariant,
+  MegaSatanVariant,
+  MoleVariant,
   MotherVariant,
   PooterVariant,
+  RoundWormVariant,
+  SubHorfVariant,
+  SuckerVariant,
+  UltraGreedVariant,
+  WallCreepVariant,
 } from "isaac-typescript-definitions";
 
 /**
- * Corresponds to:
+ * "Armor" refers to the damage scaling mechanic. The following list corresponds to the entities
+ * that have the "shieldStrength" field in the "entities2.xml" file, with some exceptions.
+ * (Invulnerable enemies are not included. Furthermore, Ultra Greed, Ultra Greedier, and Delirium
+ * all have damage scaling, but do not have a corresponding "shieldStrength" field.)
+ *
+ * Also see:
  * https://bindingofisaacrebirth.fandom.com/wiki/Damage_Scaling#Entities_with_Armor_Values
  *
- * We use the entity ID instead of type + variant tuple so that we can have O(1) lookups.
+ * We use strings instead of a type + variant tuple so that we can have O(1) lookups.
  */
 export const ENTITIES_WITH_ARMOR_SET = new Set([
   `${EntityType.POOTER}.${PooterVariant.TAINTED_POOTER}`, // 14.2
   `${EntityType.HIVE}.${HiveVariant.TAINTED_MULLIGAN}`, // 22.3
-  `${EntityType.BOOM_FLY}.${BoomFlyVariant.TAINTED_BOOM_FLY}`, // 22.6
+  `${EntityType.BOOM_FLY}.${BoomFlyVariant.TAINTED_BOOM_FLY}`, // 25.6
   `${EntityType.HOPPER}.${HopperVariant.TAINTED_HOPPER}`, // 29.3
   `${EntityType.SPITTY}`, // 31.1
-  // 61.7
-  // 102.2
-  // 240.3
-  // 244.2
-  // 244.3
-  // 274.0
-  // 274.1
-  // 274.2
-  // 275.0
-  // 275.1
-  // 275.2
-  // 406.0
-  // 407.0
-  // 412.0
-  // 802.0
-  // 802.1
-  // 812.1
-  // 827.1
-  // 829.1
-  // 831.0
-  // 850.0
-  // 850.1
-  // 850.2
-  // 855.0
-  // 855.1
-  // 888.0
+  `${EntityType.SUCKER}.${SuckerVariant.TAINTED_SUCKER}`, // 61.7
+  `${EntityType.ISAAC}.${IsaacVariant.BLUE_BABY_HUSH}`, // 102.2
+  `${EntityType.WALL_CREEP}.${WallCreepVariant.TAINTED_SOY_CREEP}`, // 240.3
+  `${EntityType.ROUND_WORM}.${RoundWormVariant.TAINTED_ROUND_WORM}`, // 244.2
+  `${EntityType.ROUND_WORM}.${RoundWormVariant.TAINTED_TUBE_WORM}`, // 244.3
+  `${EntityType.MEGA_SATAN}.${MegaSatanVariant.MEGA_SATAN}`, // 274.0
+  `${EntityType.MEGA_SATAN}.${MegaSatanVariant.MEGA_SATAN_RIGHT_HAND}`, // 274.1
+  `${EntityType.MEGA_SATAN}.${MegaSatanVariant.MEGA_SATAN_LEFT_HAND}`, // 274.2
+  `${EntityType.MEGA_SATAN_2}.${MegaSatanVariant.MEGA_SATAN}`, // 275.0
+  `${EntityType.MEGA_SATAN_2}.${MegaSatanVariant.MEGA_SATAN_RIGHT_HAND}`, // 275.1
+  `${EntityType.MEGA_SATAN_2}.${MegaSatanVariant.MEGA_SATAN_LEFT_HAND}`, // 275.2
+  `${EntityType.ULTRA_GREED}.${UltraGreedVariant.ULTRA_GREED}`, // 406.0
+  `${EntityType.ULTRA_GREED}.${UltraGreedVariant.ULTRA_GREEDIER}`, // 406.1
+  `${EntityType.HUSH}.0`, // 407.0
+  `${EntityType.DELIRIUM}.0`, // 412.0
+  `${EntityType.BLOOD_PUPPY}.${BloodPuppyVariant.SMALL}`, // 802.0
+  `${EntityType.BLOOD_PUPPY}.${BloodPuppyVariant.LARGE}`, // 802.1
+  `${EntityType.SUB_HORF}.${SubHorfVariant.TAINTED_SUB_HORF}`, // 812.1
+  `${EntityType.FACELESS}.${FacelessVariant.TAINTED_FACELESS}`, // 827.1
+  `${EntityType.MOLE}.${MoleVariant.TAINTED_MOLE}`, // 829.1
+  `${EntityType.GUTTED_FATTY}.${GuttyFattyVariant.GUTTED_FATTY}`, // 831.0
+  `${EntityType.GAPER_L2}.${Gaper2Variant.GAPER}`, // 850.0
+  `${EntityType.GAPER_L2}.${Gaper2Variant.HORF}`, // 850.1
+  `${EntityType.GAPER_L2}.${Gaper2Variant.GUSHER}`, // 850.2
+  `${EntityType.CHARGER_L2}.${Charger2Variant.CHARGER}`, // 855.0
+  `${EntityType.CHARGER_L2}.${Charger2Variant.ELLEECH}`, // 855.1
+  `${EntityType.SHADY}.0`, // 888.0
   `${EntityType.MOTHER}.${MotherVariant.MOTHER_1}`, // 912.0
   `${EntityType.MOTHER}.${MotherVariant.MOTHER_2}`, // 912.10
-  `${EntityType.DOGMA}.${DogmaVariant.DOGMA_PHASE_1}`, // 950.0
+  `${EntityType.DOGMA}.${DogmaVariant.TV}`, // 950.1
+  `${EntityType.DOGMA}.${DogmaVariant.ANGEL_PHASE_2}`, // 950.2
   `${EntityType.BEAST}.${BeastVariant.BEAST}`, // 951.0
   `${EntityType.BEAST}.${BeastVariant.ULTRA_FAMINE}`, // 951.10
   `${EntityType.BEAST}.${BeastVariant.ULTRA_PESTILENCE}`, // 951.20