isaacscript-common 6.11.1 → 6.13.0

package/dist/features/roomHistory.lua

@@ -0,0 +1,89 @@
+local ____exports = {}
+local postNewRoomEarly, v
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____ModCallbackCustom = require("enums.ModCallbackCustom")
+local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
+local ____featuresInitialized = require("featuresInitialized")
+local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____array = require("functions.array")
+local getLastElement = ____array.getLastElement
+local ____roomData = require("functions.roomData")
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomListIndex = ____roomData.getRoomListIndex
+local getRoomName = ____roomData.getRoomName
+local getRoomStageID = ____roomData.getRoomStageID
+local getRoomSubType = ____roomData.getRoomSubType
+local getRoomVariant = ____roomData.getRoomVariant
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+function postNewRoomEarly(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local stageID = getRoomStageID(nil)
+    local roomVariant = getRoomVariant(nil)
+    local roomSubType = getRoomSubType(nil)
+    local roomName = getRoomName(nil)
+    local roomGridIndex = getRoomGridIndex(nil)
+    local roomListIndex = getRoomListIndex(nil)
+    local roomDescription = {
+        stage = stage,
+        stageType = stageType,
+        stageID = stageID,
+        roomType = roomType,
+        roomVariant = roomVariant,
+        roomSubType = roomSubType,
+        roomName = roomName,
+        roomGridIndex = roomGridIndex,
+        roomListIndex = roomListIndex
+    }
+    local ____v_run_roomHistory_0 = v.run.roomHistory
+    ____v_run_roomHistory_0[#____v_run_roomHistory_0 + 1] = roomDescription
+end
+local FEATURE_NAME = "roomHistory"
+v = {run = {roomHistory = {}}}
+---
+-- @internal
+function ____exports.roomHistoryInit(self, mod)
+    saveDataManager(nil, FEATURE_NAME, v)
+    mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_EARLY, postNewRoomEarly)
+end
+--- Helper function to get information about all of the rooms that a player has visited thus far on
+-- this run.
+function ____exports.getRoomHistory(self)
+    errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
+    return v.run.roomHistory
+end
+--- Helper function to get information about the room that was previously visited.
+-- 
+-- In the special case of only one room having been visited thus far (i.e. the starting room of the
+-- run), the starting room will be returned.
+function ____exports.getPreviousRoomDescription(self)
+    local previousRoomDescription = v.run.roomHistory[#v.run.roomHistory - 2 + 1]
+    if previousRoomDescription ~= nil then
+        return previousRoomDescription
+    end
+    local startingRoomDescription = v.run.roomHistory[1]
+    if startingRoomDescription ~= nil then
+        return startingRoomDescription
+    end
+    error("Failed to find a room description for any rooms thus far on this run.")
+end
+--- Helper function to get information about the most recent room that is stored in the room history
+-- array.
+-- 
+-- This is useful in the `POST_ENTITY_REMOVE` callback, since if an entity is despawning due to a
+-- player having left the room, the current room will have changed already, but the `POST_NEW_ROOM`
+-- callback will not have fired yet, and there will not be an entry in the room history array for
+-- the current room.
+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
+end
+return ____exports

package/dist/features/taintedLazarusPlayers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"taintedLazarusPlayers.d.ts","sourceRoot":"","sources":["../../src/features/taintedLazarusPlayers.ts"],"names":[],"mappings":";AAoFA;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,YAAY,GACnB,YAAY,GAAG,SAAS,CAe1B"}
+{"version":3,"file":"taintedLazarusPlayers.d.ts","sourceRoot":"","sources":["../../src/features/taintedLazarusPlayers.ts"],"names":[],"mappings":";AA+FA;;;;;;;;;;GAUG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,YAAY,GACnB,YAAY,GAAG,SAAS,CAK1B"}

package/dist/features/taintedLazarusPlayers.lua

@@ -8,17 +8,18 @@ local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
+local ____log = require("functions.log")
+local logError = ____log.logError
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 function postPlayerInit(self, player)
-    local entityPtr = EntityPtr(player)
     local character = player:GetPlayerType()
     if character == PlayerType.LAZARUS_B then
         local ____v_run_queuedTaintedLazarus_0 = v.run.queuedTaintedLazarus
-        ____v_run_queuedTaintedLazarus_0[#____v_run_queuedTaintedLazarus_0 + 1] = entityPtr
+        ____v_run_queuedTaintedLazarus_0[#____v_run_queuedTaintedLazarus_0 + 1] = player
     elseif character == PlayerType.LAZARUS_2_B then
         local ____v_run_queuedDeadTaintedLazarus_1 = v.run.queuedDeadTaintedLazarus
-        ____v_run_queuedDeadTaintedLazarus_1[#____v_run_queuedDeadTaintedLazarus_1 + 1] = entityPtr
+        ____v_run_queuedDeadTaintedLazarus_1[#____v_run_queuedDeadTaintedLazarus_1 + 1] = player
     else
         return
     end
@@ -28,20 +29,19 @@ function checkDequeue(self)
     if #v.run.queuedTaintedLazarus == 0 or #v.run.queuedDeadTaintedLazarus == 0 then
         return
     end
-    local taintedLazarusPtr = table.remove(v.run.queuedTaintedLazarus, 1)
-    local deadTaintedLazarusPtr = table.remove(v.run.queuedDeadTaintedLazarus, 1)
-    if taintedLazarusPtr == nil or deadTaintedLazarusPtr == nil then
-        return
-    end
-    local taintedLazarus = taintedLazarusPtr.Ref
-    local deadTaintedLazarus = deadTaintedLazarusPtr.Ref
+    local taintedLazarus = table.remove(v.run.queuedTaintedLazarus, 1)
+    local deadTaintedLazarus = table.remove(v.run.queuedDeadTaintedLazarus, 1)
     if taintedLazarus == nil or deadTaintedLazarus == nil then
         return
     end
     local taintedLazarusPtrHash = GetPtrHash(taintedLazarus)
     local deadTaintedLazarusPtrHash = GetPtrHash(deadTaintedLazarus)
-    v.run.subPlayerMap:set(taintedLazarusPtrHash, deadTaintedLazarusPtr)
-    v.run.subPlayerMap:set(deadTaintedLazarusPtrHash, taintedLazarusPtr)
+    if taintedLazarusPtrHash == deadTaintedLazarusPtrHash then
+        logError("Failed to cache the Tainted Lazarus player objects, since the hash for Tainted Lazarus and Dead Tainted Lazarus were the same.")
+        return
+    end
+    v.run.subPlayerMap:set(taintedLazarusPtrHash, deadTaintedLazarus)
+    v.run.subPlayerMap:set(deadTaintedLazarusPtrHash, taintedLazarus)
 end
 local FEATURE_NAME = "taintedLazarusPlayers"
 v = {run = {
@@ -72,14 +72,6 @@ end
 function ____exports.getTaintedLazarusSubPlayer(self, player)
     errorIfFeaturesNotInitialized(nil, FEATURE_NAME)
     local ptrHash = GetPtrHash(player)
-    local entityPtr = v.run.subPlayerMap:get(ptrHash)
-    if entityPtr == nil then
-        return nil
-    end
-    local entity = entityPtr.Ref
-    if entity == nil then
-        return nil
-    end
-    return entity:ToPlayer()
+    return v.run.subPlayerMap:get(ptrHash)
 end
 return ____exports

package/dist/functions/collectibles.d.ts

@@ -24,38 +24,51 @@ export declare function getCollectibleDevilHeartPrice(collectibleType: Collectib
  */
 export declare function getCollectibleGfxFilename(collectibleType: CollectibleType): string;
 /**
- * Mods often have to track variables relating to a collectible. Finding an index for these kinds of
- * data structures is difficult, since collectibles are respawned every time a player re-enters a
- * room, so the `PtrHash` will change. Instead, we use a 4-tuple of the room list index, the grid
- * index of the collectible in the room, the collectible's SubType, and the collectible's InitSeed.
+ * Mods may have to keep track of data relating to a collectible. Finding an index for these kinds
+ * of data structures is difficult, since collectibles are respawned every time a player re-enters a
+ * room (like all other pickups), so the `PtrHash` will change.
+ *
+ * Use this function to get a unique index for a collectible to use in these data structures.
+ *
+ * If your mod is upgraded, then you should use the `getPickupIndex` function instead, as it is more
+ * general purpose and less prone to error (but relies on stateful tracking of pickups as the run
+ * progresses).
+ *
+ * Collectibles are a special case of pickups: they cannot be pushed around. (They actually can be
+ * pushed, but usually will stay on the same grid index.) Thus, it is possible to generate a
+ * somewhat reliable non-stateful index for collectibles. We use a 4-tuple of the room list index,
+ * the grid index of the collectible in the room, the collectible's `SubType`, and the collectible's
+ * `InitSeed`.
  *
  * Collectibles that are shifted by Tainted Isaac's mechanic will have unique collectible indexes
- * because the SubType is different. (The collectible entities share the same InitSeed.)
+ * because the `SubType` is different. (The collectible entities share the same `InitSeed` and
+ * `PtrHash`.)
  *
  * Collectibles that are rolled (with e.g. a D6) will have unique collectible indexes because the
- * SubType and InitSeed are different. If you want to track collectibles independently of any
+ * `SubType` and `InitSeed` are different. If you want to track collectibles independently of any
  * rerolls, then you can use the `PtrHash` as an index instead. (The `PtrHash` will not persist
  * between rooms, however.)
  *
  * Note that:
  * - The grid index is a necessary part of the collectible index because Diplopia and Crooked Penny
- *   can cause two or more collectibles with the same SubType and InitSeed to exist in the same
+ *   can cause two or more collectibles with the same `SubType` and `InitSeed` to exist in the same
  *   room.
  * - This index will fail in the case where the player uses Diplopia or a successful Crooked Penny
  *   seven or more times in the same room, since that will cause two or more collectibles with the
- *   same grid index, SubType, and InitSeed to exist.
- * - The SubType is a necessary part of the collectible index because Tainted Isaac will
- *   continuously cause collectibles to morph into new sub-types with the same InitSeed.
+ *   same grid index, `SubType`, and `InitSeed` to exist. (More than seven is required in non-1x1
+ *   rooms.)
+ * - The `SubType` is a necessary part of the collectible index because Tainted Isaac will
+ *   continuously cause collectibles to morph into new sub-types with the same `InitSeed`.
  * - Using a collectible's position as part of the index is problematic, since players can push a
  *   pedestal. (Even using the grid index does not solve this problem, since it is possible in
  *   certain cases for collectibles to be spawned at a position that is not aligned with the grid,
  *   and the pedestal pushed to an adjacent tile, but this case should be extremely rare.)
  * - Mega Chests spawn two collectibles on the exact same position. However, both of them will have
- *   different InitSeeds, so this is not a problem for this indexing scheme.
+ *   a different `InitSeed`, so this is not a problem for this indexing scheme.
  * - The indexing scheme used is different for collectibles that are inside of a Treasure Room or
  *   Boss Room, in order to handle the case of the player seeing the same collectible again in a
- *   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, SubType,
- *   and InitSeed is used in this case. (Using the room list index or the room grid index is not
+ *   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, `SubType`,
+ *   and `InitSeed` is used in this case. (Using the room list index or the room grid index is not
  *   suitable for this purpose, since both of these values can change in the post-Ascent rooms.)
  *   Even though Treasure Rooms and Boss Rooms are grouped together in this scheme, there probably
  *   will not be collectibles with the same grid index, SubType, and InitSeed.

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

@@ -1 +1 @@
-{"version":3,"file":"collectibles.d.ts","sourceRoot":"","sources":["../../src/functions/collectibles.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,eAAe,EAEf,aAAa,EAEb,QAAQ,EACR,WAAW,EAGZ,MAAM,8BAA8B,CAAC;AAkBtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAyB7D,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAEtE;AAED,6FAA6F;AAC7F,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAsBT;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAeR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,eAAe,EAAE,eAAe,GAC/B,GAAG,CAYL;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,YAAY,GACnB,WAAW,CAyBb;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAOR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GACxB,gBAAgB,CAsBlB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,GAAG,CAOL;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAOV;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,GAAG,CAOL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAc3E;AAED,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,GACxB,uBAAuB,CAUzB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,eAAe,EAAE,eAAe,GAAG,GAAG,CAO3E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,aAAa,CAAC,CAGzB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,IAAI,eAAe,EAAE,CAS7D;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,IAAI,eAAe,EAAE,CAKlE;AAED,2FAA2F;AAC3F,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED,sEAAsE;AACtE,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAcrE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAKnE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,eAAe,EAAE,eAAe,GAC/B,IAAI,CAQN;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAS5E;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CASnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAUnE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAuBtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,YAAY,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAeN;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,YAAY,EACzB,kBAAkB,EAAE,eAAe,GAClC,IAAI,CA2BN;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAK5D"}
+{"version":3,"file":"collectibles.d.ts","sourceRoot":"","sources":["../../src/functions/collectibles.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,eAAe,EAEf,aAAa,EAEb,QAAQ,EACR,WAAW,EAGZ,MAAM,8BAA8B,CAAC;AAkBtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAyB7D,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAEtE;AAED,6FAA6F;AAC7F,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAsBT;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAeR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,eAAe,EAAE,eAAe,GAC/B,GAAG,CAYL;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,YAAY,GACnB,WAAW,CAyBb;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,eAAe,EAAE,eAAe,GAC/B,MAAM,CAOR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,YAAY,GACxB,gBAAgB,CAsBlB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,GAAG,CAOL;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAOV;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,GAAG,CAOL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAc3E;AAED,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,GACxB,uBAAuB,CAUzB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,eAAe,EAAE,eAAe,GAAG,GAAG,CAO3E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,eAAe,GAC/B,QAAQ,CAAC,aAAa,CAAC,CAGzB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,IAAI,eAAe,EAAE,CAS7D;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,IAAI,eAAe,EAAE,CAKlE;AAED,2FAA2F;AAC3F,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED,sEAAsE;AACtE,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAcrE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAKnE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,eAAe,EAAE,eAAe,GAC/B,IAAI,CAQN;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAS5E;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CASnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAUnE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAuBtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,YAAY,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAeN;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,YAAY,EACzB,kBAAkB,EAAE,eAAe,GAClC,IAAI,CA2BN;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAK5D"}

package/dist/functions/collectibles.lua

@@ -182,38 +182,51 @@ function ____exports.getCollectibleGfxFilename(self, collectibleType)
     end
     return itemConfigItem.GfxFileName
 end
---- Mods often have to track variables relating to a collectible. Finding an index for these kinds of
--- data structures is difficult, since collectibles are respawned every time a player re-enters a
--- room, so the `PtrHash` will change. Instead, we use a 4-tuple of the room list index, the grid
--- index of the collectible in the room, the collectible's SubType, and the collectible's InitSeed.
+--- Mods may have to keep track of data relating to a collectible. Finding an index for these kinds
+-- of data structures is difficult, since collectibles are respawned every time a player re-enters a
+-- room (like all other pickups), so the `PtrHash` will change.
+-- 
+-- Use this function to get a unique index for a collectible to use in these data structures.
+-- 
+-- If your mod is upgraded, then you should use the `getPickupIndex` function instead, as it is more
+-- general purpose and less prone to error (but relies on stateful tracking of pickups as the run
+-- progresses).
+-- 
+-- Collectibles are a special case of pickups: they cannot be pushed around. (They actually can be
+-- pushed, but usually will stay on the same grid index.) Thus, it is possible to generate a
+-- somewhat reliable non-stateful index for collectibles. We use a 4-tuple of the room list index,
+-- the grid index of the collectible in the room, the collectible's `SubType`, and the collectible's
+-- `InitSeed`.
 -- 
 -- Collectibles that are shifted by Tainted Isaac's mechanic will have unique collectible indexes
--- because the SubType is different. (The collectible entities share the same InitSeed.)
+-- because the `SubType` is different. (The collectible entities share the same `InitSeed` and
+-- `PtrHash`.)
 -- 
 -- Collectibles that are rolled (with e.g. a D6) will have unique collectible indexes because the
--- SubType and InitSeed are different. If you want to track collectibles independently of any
+-- `SubType` and `InitSeed` are different. If you want to track collectibles independently of any
 -- rerolls, then you can use the `PtrHash` as an index instead. (The `PtrHash` will not persist
 -- between rooms, however.)
 -- 
 -- Note that:
 -- - The grid index is a necessary part of the collectible index because Diplopia and Crooked Penny
---   can cause two or more collectibles with the same SubType and InitSeed to exist in the same
+--   can cause two or more collectibles with the same `SubType` and `InitSeed` to exist in the same
 --   room.
 -- - This index will fail in the case where the player uses Diplopia or a successful Crooked Penny
 --   seven or more times in the same room, since that will cause two or more collectibles with the
---   same grid index, SubType, and InitSeed to exist.
--- - The SubType is a necessary part of the collectible index because Tainted Isaac will
---   continuously cause collectibles to morph into new sub-types with the same InitSeed.
+--   same grid index, `SubType`, and `InitSeed` to exist. (More than seven is required in non-1x1
+--   rooms.)
+-- - The `SubType` is a necessary part of the collectible index because Tainted Isaac will
+--   continuously cause collectibles to morph into new sub-types with the same `InitSeed`.
 -- - Using a collectible's position as part of the index is problematic, since players can push a
 --   pedestal. (Even using the grid index does not solve this problem, since it is possible in
 --   certain cases for collectibles to be spawned at a position that is not aligned with the grid,
 --   and the pedestal pushed to an adjacent tile, but this case should be extremely rare.)
 -- - Mega Chests spawn two collectibles on the exact same position. However, both of them will have
---   different InitSeeds, so this is not a problem for this indexing scheme.
+--   a different `InitSeed`, so this is not a problem for this indexing scheme.
 -- - The indexing scheme used is different for collectibles that are inside of a Treasure Room or
 --   Boss Room, in order to handle the case of the player seeing the same collectible again in a
---   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, SubType,
---   and InitSeed is used in this case. (Using the room list index or the room grid index is not
+--   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, `SubType`,
+--   and `InitSeed` is used in this case. (Using the room list index or the room grid index is not
 --   suitable for this purpose, since both of these values can change in the post-Ascent rooms.)
 --   Even though Treasure Rooms and Boss Rooms are grouped together in this scheme, there probably
 --   will not be collectibles with the same grid index, SubType, and InitSeed.

package/dist/functions/entities.d.ts

@@ -65,10 +65,10 @@ export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity:
 export declare function getEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): Entity[];
 /**
  * Helper function to get all the fields on an entity. For example, this is useful for comparing it
- * to another entity later.
+ * to another entity later. (One option is to use the `logTableDifferences` function for this.)
  *
- * This function will only get fields that are equal to booleans, numbers, or strings, as comparing
- * other types is non-trivial.
+ * This function will only get fields that are equal to booleans, numbers, or strings, or Vectors,
+ * as comparing other types is non-trivial.
  */
 export declare function getEntityFields(entity: Entity): LuaMap<string, boolean | number | string>;
 /** Helper function to return a string containing the entity's type, variant, and sub-type. */

package/dist/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;AAM/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;AAwBD,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;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,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,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;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAO/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,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;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,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,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/functions/entities.lua

@@ -20,6 +20,9 @@ local isRNG = ____rng.isRNG
 local newRNG = ____rng.newRNG
 local ____types = require("functions.types")
 local isPrimitive = ____types.isPrimitive
+local ____vector = require("functions.vector")
+local isVector = ____vector.isVector
+local vectorToString = ____vector.vectorToString
 function setPrimitiveEntityFields(self, entity, metatable, entityFields)
     local propGetTable = metatable.__propget
     if propGetTable == nil then
@@ -30,6 +33,8 @@ function setPrimitiveEntityFields(self, entity, metatable, entityFields)
         local value = entity[indexKey]
         if isPrimitive(nil, value) then
             entityFields[indexKey] = value
+        elseif isVector(nil, value) then
+            entityFields[indexKey] = vectorToString(nil, value)
         end
     end
 end
@@ -180,10 +185,10 @@ function ____exports.getEntities(self, entityType, variant, subType, ignoreFrien
     return Isaac.FindByType(entityType, variant, subType, ignoreFriendly)
 end
 --- Helper function to get all the fields on an entity. For example, this is useful for comparing it
--- to another entity later.
+-- to another entity later. (One option is to use the `logTableDifferences` function for this.)
 -- 
--- This function will only get fields that are equal to booleans, numbers, or strings, as comparing
--- other types is non-trivial.
+-- This function will only get fields that are equal to booleans, numbers, or strings, or Vectors,
+-- as comparing other types is non-trivial.
 function ____exports.getEntityFields(self, entity)
     local entityFields = {}
     local metatable = getmetatable(entity)

package/dist/functions/gridEntities.d.ts

@@ -17,8 +17,8 @@ export declare function getAllGridIndexes(): int[];
  * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
  * entity is on.
  *
- * Note that this function will not work properly in the PostNewRoom callback, since entities do not
- * have collision yet in that callback.
+ * Note that this function will not work properly in the `POST_NEW_ROOM` callback, since entities do
+ * not have collision yet in that callback.
  */
 export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntity): Entity[];
 /**

package/dist/functions/gridEntities.lua

@@ -200,8 +200,8 @@ end
 --- Gets the entities that have a hitbox that overlaps with any part of the square that the grid
 -- entity is on.
 -- 
--- Note that this function will not work properly in the PostNewRoom callback, since entities do not
--- have collision yet in that callback.
+-- Note that this function will not work properly in the `POST_NEW_ROOM` callback, since entities do
+-- not have collision yet in that callback.
 function ____exports.getCollidingEntitiesWithGridEntity(self, gridEntity)
     local gridEntityCollisionTopLeft = Vector(gridEntity.Position.X - DISTANCE_OF_GRID_TILE / 2, gridEntity.Position.Y - DISTANCE_OF_GRID_TILE / 2)
     local gridEntityCollisionBottomRight = Vector(gridEntity.Position.X + DISTANCE_OF_GRID_TILE / 2, gridEntity.Position.Y + DISTANCE_OF_GRID_TILE / 2)

package/dist/functions/isaacAPIClass.d.ts

@@ -1,3 +1,22 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 import { IsaacAPIClass } from "../types/private/IsaacAPIClass";
 /**
  * Helper function to get the name of a class from the Isaac API. This is contained within the
@@ -7,8 +26,27 @@ import { IsaacAPIClass } from "../types/private/IsaacAPIClass";
  *
  * Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
  * not exist.
+ *
+ * In some cases, Isaac classes can be a read-only. If this is the case, the "__type" field will be
+ * prepended with "const ". This function will always strip this prefix, if it exists. For example,
+ * the class name returned for "const Vector" will be "Vector".
  */
 export declare function getIsaacAPIClassName(object: unknown): string | undefined;
+/** Helper function to detect if a variable is of type `EntityBomb`. */
+export declare function isBomb(variable: unknown): variable is EntityBomb;
+/** Helper function to detect if a variable is of type `GridEntityDoor`. */
+export declare function isDoor(variable: unknown): variable is GridEntityDoor;
+/** Helper function to detect if a variable is of type `EntityEffect`. */
+export declare function isEffect(variable: unknown): variable is EntityEffect;
+/**
+ * Helper function to detect if a variable is of type `Entity`. This will return false for child
+ * classes such as `EntityPlayer` or `EntityTear`.
+ */
+export declare function isEntity(variable: unknown): variable is Entity;
+/** Helper function to detect if a variable is of type `EntityEffect`. */
+export declare function isFamiliar(variable: unknown): variable is EntityFamiliar;
+/** Helper function to detect if a variable is of type `GridEntity`. */
+export declare function isGridEntity(variable: unknown): variable is GridEntity;
 /**
  * Helper function to check if something is an instantiated class from the Isaac API. (All classes
  * from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type" equal to the
@@ -16,6 +54,32 @@ export declare function getIsaacAPIClassName(object: unknown): string | undefine
  */
 export declare function isIsaacAPIClass(object: unknown): object is IsaacAPIClass;
 export declare function isIsaacAPIClassOfType(object: unknown, classType: string): boolean;
+/** Helper function to detect if a variable is of type `EntityKnife`. */
+export declare function isKnife(variable: unknown): variable is EntityKnife;
+/** Helper function to detect if a variable is of type `EntityLaser`. */
+export declare function isLaser(variable: unknown): variable is EntityLaser;
+/** Helper function to detect if a variable is of type `EntityNPC`. */
+export declare function isNPC(variable: unknown): variable is EntityNPC;
+/** Helper function to detect if a variable is of type `EntityPickup`. */
+export declare function isPickup(variable: unknown): variable is EntityPickup;
+/** Helper function to detect if a variable is of type `GridEntityPit`. */
+export declare function isPit(variable: unknown): variable is GridEntityPit;
+/** Helper function to detect if a variable is of type `EntityPlayer`. */
+export declare function isPlayer(variable: unknown): variable is EntityPlayer;
+/** Helper function to detect if a variable is of type `GridEntityPoop`. */
+export declare function isPoop(variable: unknown): variable is GridEntityPoop;
+/** Helper function to detect if a variable is of type `GridEntityPressurePlate`. */
+export declare function isPressurePlate(variable: unknown): variable is GridEntityPressurePlate;
+/** Helper function to detect if a variable is of type `EntityProjectile`. */
+export declare function isProjectile(variable: unknown): variable is EntityProjectile;
+/** Helper function to detect if a variable is of type `GridEntityRock`. */
+export declare function isRock(variable: unknown): variable is GridEntityRock;
+/** Helper function to detect if a variable is of type `GridEntitySpikes`. */
+export declare function isSpikes(variable: unknown): variable is GridEntitySpikes;
+/** Helper function to detect if a variable is of type `GridEntityTNT`. */
+export declare function isTNT(variable: unknown): variable is GridEntityTNT;
+/** Helper function to detect if a variable is of type `EntityTear`. */
+export declare function isTear(variable: unknown): variable is EntityTear;
 /**
  * Helper function to check if an instantiated Isaac API class is equal to another one of the same
  * type. You must provide the list of keys to check for.

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

@@ -1 +1 @@
-{"version":3,"file":"isaacAPIClass.d.ts","sourceRoot":"","sources":["../../src/functions/isaacAPIClass.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAG/D;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAkBxE;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAGxE;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,OAAO,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAMT;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAKT"}
+{"version":3,"file":"isaacAPIClass.d.ts","sourceRoot":"","sources":["../../src/functions/isaacAPIClass.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAI/D;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAkBxE;AAED,uEAAuE;AACvE,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,UAAU,CAEhE;AAED,2EAA2E;AAC3E,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,cAAc,CAEpE;AAED,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,YAAY,CAEpE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,yEAAyE;AACzE,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,cAAc,CAExE;AAED,uEAAuE;AACvE,wBAAgB,YAAY,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,UAAU,CAEtE;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAGxE;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,OAAO,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAMT;AAED,wEAAwE;AACxE,wBAAgB,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAElE;AAED,wEAAwE;AACxE,wBAAgB,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAElE;AAED,sEAAsE;AACtE,wBAAgB,KAAK,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,SAAS,CAE9D;AAED,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,YAAY,CAEpE;AAED,0EAA0E;AAC1E,wBAAgB,KAAK,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,aAAa,CAElE;AAED,yEAAyE;AACzE,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,YAAY,CAEpE;AAED,2EAA2E;AAC3E,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,cAAc,CAEpE;AAED,oFAAoF;AACpF,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,uBAAuB,CAErC;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,gBAAgB,CAE5E;AAED,2EAA2E;AAC3E,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,cAAc,CAEpE;AAED,6EAA6E;AAC7E,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,gBAAgB,CAExE;AAED,0EAA0E;AAC1E,wBAAgB,KAAK,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,aAAa,CAElE;AAED,uEAAuE;AACvE,wBAAgB,MAAM,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,UAAU,CAEhE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAKT"}

package/dist/functions/isaacAPIClass.lua

@@ -1,6 +1,8 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
+local ____string = require("functions.string")
+local trimPrefix = ____string.trimPrefix
 local ____types = require("functions.types")
 local isString = ____types.isString
 local isUserdata = ____types.isUserdata
@@ -11,6 +13,10 @@ local isUserdata = ____types.isUserdata
 -- 
 -- Returns undefined if the object is not of type `userdata` or if the "__type" metatable key does
 -- not exist.
+-- 
+-- In some cases, Isaac classes can be a read-only. If this is the case, the "__type" field will be
+-- prepended with "const ". This function will always strip this prefix, if it exists. For example,
+-- the class name returned for "const Vector" will be "Vector".
 function ____exports.getIsaacAPIClassName(self, object)
     if not isUserdata(nil, object) then
         return nil
@@ -23,7 +29,32 @@ function ____exports.getIsaacAPIClassName(self, object)
     if not isString(nil, classType) then
         return nil
     end
-    return classType
+    return trimPrefix(nil, classType, "const ")
+end
+--- Helper function to detect if a variable is of type `EntityBomb`.
+function ____exports.isBomb(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityBomb"
+end
+--- Helper function to detect if a variable is of type `GridEntityDoor`.
+function ____exports.isDoor(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntityDoor"
+end
+--- Helper function to detect if a variable is of type `EntityEffect`.
+function ____exports.isEffect(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityEffect"
+end
+--- Helper function to detect if a variable is of type `Entity`. This will return false for child
+-- classes such as `EntityPlayer` or `EntityTear`.
+function ____exports.isEntity(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "Entity"
+end
+--- Helper function to detect if a variable is of type `EntityEffect`.
+function ____exports.isFamiliar(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityEffect"
+end
+--- Helper function to detect if a variable is of type `GridEntity`.
+function ____exports.isGridEntity(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntity"
 end
 --- Helper function to check if something is an instantiated class from the Isaac API. (All classes
 -- from the Isaac API have a type of "userdata" in Lua with a metatable key of "__type" equal to the
@@ -36,6 +67,58 @@ function ____exports.isIsaacAPIClassOfType(self, object, classType)
     local isaacAPIClassType = ____exports.getIsaacAPIClassName(nil, object)
     return isaacAPIClassType == classType or isaacAPIClassType == "const " .. classType
 end
+--- Helper function to detect if a variable is of type `EntityKnife`.
+function ____exports.isKnife(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityKnife"
+end
+--- Helper function to detect if a variable is of type `EntityLaser`.
+function ____exports.isLaser(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityLaser"
+end
+--- Helper function to detect if a variable is of type `EntityNPC`.
+function ____exports.isNPC(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityNPC"
+end
+--- Helper function to detect if a variable is of type `EntityPickup`.
+function ____exports.isPickup(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityPickup"
+end
+--- Helper function to detect if a variable is of type `GridEntityPit`.
+function ____exports.isPit(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntityPit"
+end
+--- Helper function to detect if a variable is of type `EntityPlayer`.
+function ____exports.isPlayer(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityPlayer"
+end
+--- Helper function to detect if a variable is of type `GridEntityPoop`.
+function ____exports.isPoop(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntityPoop"
+end
+--- Helper function to detect if a variable is of type `GridEntityPressurePlate`.
+function ____exports.isPressurePlate(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntityPressurePlate"
+end
+--- Helper function to detect if a variable is of type `EntityProjectile`.
+function ____exports.isProjectile(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityProjectile"
+end
+--- Helper function to detect if a variable is of type `GridEntityRock`.
+function ____exports.isRock(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntityRock"
+end
+--- Helper function to detect if a variable is of type `GridEntitySpikes`.
+function ____exports.isSpikes(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntitySpikes"
+end
+--- Helper function to detect if a variable is of type `GridEntityTNT`.
+function ____exports.isTNT(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "GridEntityTNT"
+end
+--- Helper function to detect if a variable is of type `EntityTear`.
+function ____exports.isTear(self, variable)
+    return ____exports.getIsaacAPIClassName(nil, variable) == "EntityTear"
+end
 --- Helper function to check if an instantiated Isaac API class is equal to another one of the same
 -- type. You must provide the list of keys to check for.
 function ____exports.isaacAPIClassEquals(self, object1, object2, keys)

package/dist/functions/log.lua

@@ -550,14 +550,14 @@ function ____exports.logTableDifferences(table1, table2)
     __TS__ArraySort(keys)
     for ____, key in ipairs(keys) do
         if not table1KeysSet:has(key) then
-            ____exports.log("  Table 1 is missing key: " .. key)
+            ____exports.log("  Table 1 is missing key: " .. tostring(key))
         elseif not table2KeysSet:has(key) then
-            ____exports.log("  Table 2 is missing key: " .. key)
+            ____exports.log("  Table 2 is missing key: " .. tostring(key))
         else
             local value1 = table1[key]
             local value2 = table2[key]
             if value1 ~= value2 then
-                ____exports.log(((((("  " .. key) .. " --> \"") .. tostring(value1)) .. "\" versus \"") .. tostring(value2)) .. "\"")
+                ____exports.log(((((("  " .. tostring(key)) .. " --> \"") .. tostring(value1)) .. "\" versus \"") .. tostring(value2)) .. "\"")
             end
         end
     end

package/dist/functions/map.d.ts

@@ -20,4 +20,6 @@ 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 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/functions/map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":"AAAA,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,CAuBzB"}
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/functions/map.ts"],"names":[],"mappings":"AAEA,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,CAuBzB;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CACpB,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR"}