isaacscript-common 12.5.1 → 12.6.0

package/dist/index.d.ts

@@ -1665,6 +1665,12 @@ export declare class DefaultMap<Key, Value, Args extends unknown[] = []> extends
     getConstructorArg(): Value | FactoryFunction<Value, Args>;
 }
 
+/**
+ * Helper function to get the value from a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export declare function defaultMapGetHash<V, A extends unknown[]>(map: DefaultMap<PtrHash, V, A>, entity: Entity, ...extraArgs: A): V;
+
 /**
  * Helper function to make using default maps with an index of `PlayerIndex` easier. Use this
  * instead of the `DefaultMap.getAndSetDefault` method if you have a default map of this type.
@@ -1685,6 +1691,15 @@ export declare class DefaultMap<Key, Value, Args extends unknown[] = []> extends
  */
 export declare function defaultMapGetPlayer<V, A extends unknown[]>(map: DefaultMap<PlayerIndex, V, A>, player: EntityPlayer, ...extraArgs: A): V;
 
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ *
+ * Since `Map` and `DefaultMap` set values in the same way, this function is simply an alias for the
+ * `mapSetHash` helper function.
+ */
+export declare function defaultMapSetHash<V>(map: Map<PtrHash, V>, entity: Entity, value: V): void;
+
 /**
  * Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
  * `Map.set` method if you have a map of this type.
@@ -1764,7 +1779,7 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom | Readonly<JSONRoom>,
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  *                what the function is doing. Default is false.
  */
-export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[] | readonly JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
+export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
 
 /**
  * Helper function to convert a `SerializedBitSet128` object to a normal `BitSet128` object. (This
@@ -4512,6 +4527,21 @@ export declare function getRandomFromWeightedArray<T>(weightedArray: WeightedArr
  */
 export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG, exceptions?: int[] | readonly int[]): int;
 
+/**
+ * Helper function to get a random JSON entity from an array of JSON entities.
+ *
+ * Note that this function does not simply choose a random element in the provided array; it will
+ * properly account for each room weight using the algorithm from:
+ * https://stackoverflow.com/questions/1761626/weighted-random-numbers
+ *
+ * @param jsonEntities The array of entities to randomly choose between.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+ *                what the function is doing. Default is false.
+ */
+export declare function getRandomJSONEntity(jsonEntities: JSONEntity[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONEntity;
+
 /**
  * Helper function to get a random JSON room from an array of JSON rooms.
  *
@@ -4519,13 +4549,13 @@ export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG,
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
  *
- * @param jsonRooms The array of rooms to random choose between.
+ * @param jsonRooms The array of rooms to randomly choose between.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  *                what the function is doing. Default is false.
  */
-export declare function getRandomJSONRoom(jsonRooms: JSONRoom[] | readonly JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONRoom;
+export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONRoom;
 
 /**
  * Helper function to get a random color.
@@ -6996,6 +7026,12 @@ export declare function mapGetPlayer<V>(map: Map<PlayerIndex, V>, player: Entity
  */
 export declare function mapHasPlayer<V>(map: Map<PlayerIndex, V>, player: EntityPlayer): boolean;
 
+/**
+ * Helper function to set a value for a `DefaultMap` that corresponds to an entity, assuming that
+ * the map uses `PtrHash` as an index.
+ */
+export declare function mapSetHash<V>(map: Map<PtrHash, V>, entity: Entity, value: V): void;
+
 /**
  * Helper function to make using maps with an index of `PlayerIndex` easier. Use this instead of the
  * `Map.set` method if you have a map of this type.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 12.5.1
+isaacscript-common 12.6.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -9323,7 +9323,7 @@ ____exports.ClottyVariant.GRILLED_CLOTTY = 3
 ____exports.ClottyVariant[____exports.ClottyVariant.GRILLED_CLOTTY] = "GRILLED_CLOTTY"
 --- For `EntityType.MULLIGAN` (16).
 ____exports.MulliganVariant = {}
-____exports.MulliganVariant.MULLIGAN = 16
+____exports.MulliganVariant.MULLIGAN = 0
 ____exports.MulliganVariant[____exports.MulliganVariant.MULLIGAN] = "MULLIGAN"
 ____exports.MulliganVariant.MULLIGOON = 1
 ____exports.MulliganVariant[____exports.MulliganVariant.MULLIGOON] = "MULLIGOON"
@@ -12533,6 +12533,8 @@ local ____exports = {}
 -- 
 -- The `gridspawn` console command accepts `GridEntityXMLType` instead of `GridEntityType`.
 ____exports.GridEntityXMLType = {}
+____exports.GridEntityXMLType.DECORATION = 0
+____exports.GridEntityXMLType[____exports.GridEntityXMLType.DECORATION] = "DECORATION"
 ____exports.GridEntityXMLType.ROCK = 1000
 ____exports.GridEntityXMLType[____exports.GridEntityXMLType.ROCK] = "ROCK"
 ____exports.GridEntityXMLType.ROCK_BOMB = 1001
@@ -19233,6 +19235,7 @@ local RockVariant = ____isaac_2Dtypescript_2Ddefinitions.RockVariant
 local StatueVariant = ____isaac_2Dtypescript_2Ddefinitions.StatueVariant
 local TrapdoorVariant = ____isaac_2Dtypescript_2Ddefinitions.TrapdoorVariant
 ____exports.GRID_ENTITY_XML_MAP = __TS__New(Map, {
+    {GridEntityXMLType.DECORATION, {GridEntityType.DECORATION, 0}},
     {GridEntityXMLType.ROCK, {GridEntityType.ROCK, RockVariant.NORMAL}},
     {GridEntityXMLType.ROCK_BOMB, {GridEntityType.ROCK_BOMB, 0}},
     {GridEntityXMLType.ROCK_ALT, {GridEntityType.ROCK_ALT, 0}},
@@ -40808,7 +40811,7 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local ____exports = {}
-local getTotalWeightOfJSONRooms, getJSONRoomWithChosenWeight
+local getTotalWeightOfJSONObject, getJSONObjectWithChosenWeight
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local DoorSlotFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlagZero
 local ____array = require("src.functions.array")
@@ -40824,33 +40827,34 @@ local ____random = require("src.functions.random")
 local getRandomFloat = ____random.getRandomFloat
 local ____rng = require("src.functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
-function getTotalWeightOfJSONRooms(self, jsonRooms)
+function getTotalWeightOfJSONObject(self, jsonOjectArray)
     local weights = __TS__ArrayMap(
-        jsonRooms,
-        function(____, jsonRoom)
-            local roomWeightString = jsonRoom["$"].weight
-            local roomWeight = tonumber(roomWeightString)
-            if roomWeight == nil then
-                error(("Failed to parse the weight of a JSON room: " .. roomWeightString) .. ".")
+        jsonOjectArray,
+        function(____, jsonObject)
+            local weightString = jsonObject["$"].weight
+            local weight = tonumber(weightString)
+            if weight == nil then
+                error(("Failed to parse the weight of a JSON object: " .. tostring(weightString)) .. ".")
             end
-            return roomWeight
+            return weight
         end
     )
     return sumArray(nil, weights)
 end
-function getJSONRoomWithChosenWeight(self, jsonRooms, chosenWeight)
-    for ____, jsonRoom in ipairs(jsonRooms) do
-        local roomWeightString = jsonRoom["$"].weight
-        local roomWeight = tonumber(roomWeightString)
-        if roomWeight == nil then
-            error("Failed to parse the weight of a JSON room: " .. roomWeightString)
+function getJSONObjectWithChosenWeight(self, jsonOjectArray, chosenWeight)
+    local weightAccumulator = 0
+    for ____, jsonObject in ipairs(jsonOjectArray) do
+        local weightString = jsonObject["$"].weight
+        local weight = tonumber(weightString)
+        if weight == nil then
+            error("Failed to parse the weight of a JSON object: " .. tostring(weightString))
         end
-        if chosenWeight < roomWeight then
-            return jsonRoom
+        weightAccumulator = weightAccumulator + weight
+        if weightAccumulator >= chosenWeight then
+            return jsonObject
         end
-        chosenWeight = chosenWeight - roomWeight
     end
-    error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
+    return nil
 end
 function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
     local roomShapeString = jsonRoom["$"].shape
@@ -40917,6 +40921,33 @@ function ____exports.getJSONRoomsOfSubType(self, jsonRooms, subType)
         end
     )
 end
+function ____exports.getRandomJSONEntity(self, jsonEntities, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if verbose == nil then
+        verbose = false
+    end
+    local totalWeight = getTotalWeightOfJSONObject(nil, jsonEntities)
+    if verbose then
+        log(
+            nil,
+            "Total weight of the JSON entities provided: " .. tostring(totalWeight)
+        )
+    end
+    local chosenWeight = getRandomFloat(nil, 0, totalWeight, seedOrRNG)
+    if verbose then
+        log(
+            nil,
+            "Randomly chose weight for JSON entity: " .. tostring(chosenWeight)
+        )
+    end
+    local randomJSONEntity = getJSONObjectWithChosenWeight(nil, jsonEntities, chosenWeight)
+    if randomJSONEntity == nil then
+        error("Failed to get a JSON entity with chosen weight: " .. tostring(chosenWeight))
+    end
+    return randomJSONEntity
+end
 function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
@@ -40924,7 +40955,7 @@ function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
     if verbose == nil then
         verbose = false
     end
-    local totalWeight = getTotalWeightOfJSONRooms(nil, jsonRooms)
+    local totalWeight = getTotalWeightOfJSONObject(nil, jsonRooms)
     if verbose then
         log(
             nil,
@@ -40938,7 +40969,11 @@ function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
             "Randomly chose weight for JSON room: " .. tostring(chosenWeight)
         )
     end
-    return getJSONRoomWithChosenWeight(nil, jsonRooms, chosenWeight)
+    local randomJSONRoom = getJSONObjectWithChosenWeight(nil, jsonRooms, chosenWeight)
+    if randomJSONRoom == nil then
+        error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
+    end
+    return randomJSONRoom
 end
 return ____exports
  end,
@@ -41252,7 +41287,7 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
@@ -41261,6 +41296,7 @@ local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local GridEntityXMLType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityXMLType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 local PitfallVariant = ____isaac_2Dtypescript_2Ddefinitions.PitfallVariant
@@ -41284,6 +41320,8 @@ local ____entitiesSpecific = require("src.functions.entitiesSpecific")
 local getNPCs = ____entitiesSpecific.getNPCs
 local removeAllBombs = ____entitiesSpecific.removeAllBombs
 local removeAllPickups = ____entitiesSpecific.removeAllPickups
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
 local ____gridEntities = require("src.functions.gridEntities")
 local convertXMLGridEntityType = ____gridEntities.convertXMLGridEntityType
 local getAllGridIndexes = ____gridEntities.getAllGridIndexes
@@ -41293,6 +41331,7 @@ local removeGridEntity = ____gridEntities.removeGridEntity
 local setGridEntityInvisible = ____gridEntities.setGridEntityInvisible
 local spawnGridEntityWithVariant = ____gridEntities.spawnGridEntityWithVariant
 local ____jsonRoom = require("src.functions.jsonRoom")
+local getRandomJSONEntity = ____jsonRoom.getRandomJSONEntity
 local getRandomJSONRoom = ____jsonRoom.getRandomJSONRoom
 local ____log = require("src.functions.log")
 local log = ____log.log
@@ -41459,29 +41498,24 @@ function spawnAllEntities(self, jsonRoom, rng, verbose)
         if y == nil then
             error("Failed to convert the following y coordinate to a number (for a spawn): " .. yString)
         end
-        if #jsonSpawn.entity > 1 then
-            error("Stacked entities are not implemented for JSON rooms.")
-        end
-        local firstXMLEntity = jsonSpawn.entity[1]
-        if firstXMLEntity == nil then
-            error("Failed to get the first JSON entity from an \"entity\" array.")
-        end
-        local entityTypeString = firstXMLEntity["$"].type
+        local jsonEntity = getRandomJSONEntity(nil, jsonSpawn.entity)
+        local entityTypeString = jsonEntity["$"].type
         local entityTypeNumber = tonumber(entityTypeString)
         if entityTypeNumber == nil then
             error("Failed to convert the entity type to a number: " .. entityTypeString)
         end
-        local variantString = firstXMLEntity["$"].variant
+        local variantString = jsonEntity["$"].variant
         local variant = tonumber(variantString)
         if variant == nil then
             error("Failed to convert the entity variant to a number: " .. tostring(variant))
         end
-        local subTypeString = firstXMLEntity["$"].subtype
+        local subTypeString = jsonEntity["$"].subtype
         local subType = tonumber(subTypeString)
         if subType == nil then
             error("Failed to convert the entity sub-type to a number: " .. tostring(subType))
         end
-        if entityTypeNumber >= 1000 then
+        local isGridEntity = GRID_ENTITY_XML_TYPE_SET:has(entityTypeNumber)
+        if isGridEntity then
             local gridEntityXMLType = entityTypeNumber
             if verbose then
                 log(
@@ -41705,6 +41739,8 @@ end
 FEATURE_NAME = "deployJSONRoom"
 NPC_TYPES_TO_NOT_REMOVE = __TS__New(Set, {EntityType.DARK_ESAU})
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
+local gridEntityXMLTypes = getEnumValues(nil, GridEntityXMLType)
+GRID_ENTITY_XML_TYPE_SET = __TS__New(Set, gridEntityXMLTypes)
 v = {
     level = {
         deployedRoomListIndexes = __TS__New(Set),
@@ -42793,6 +42829,10 @@ local ____array = require("src.functions.array")
 local sumArray = ____array.sumArray
 local ____string = require("src.functions.string")
 local getPartialMatch = ____string.getPartialMatch
+function ____exports.mapSetHash(self, map, entity, value)
+    local hash = GetPtrHash(entity)
+    map:set(hash, value)
+end
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
     for ____, ____value in __TS__Iterator(oldMap:entries()) do
@@ -42802,6 +42842,13 @@ function ____exports.copyMap(self, oldMap)
     end
     return newMap
 end
+function ____exports.defaultMapGetHash(self, map, entity, ...)
+    local ptrHash = GetPtrHash(entity)
+    return map:getAndSetDefault(ptrHash, ...)
+end
+function ____exports.defaultMapSetHash(self, map, entity, value)
+    ____exports.mapSetHash(nil, map, entity, value)
+end
 function ____exports.getMapPartialMatch(self, searchText, map)
     local keys = {__TS__Spread(map:keys())}
     local matchingKey = getPartialMatch(nil, searchText, keys)

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

@@ -62,7 +62,7 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom | Readonly<JSONRoom>,
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  *                what the function is doing. Default is false.
  */
-export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[] | readonly JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
+export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
 /**
  * Helper function to remove all naturally spawning entities and grid entities from a room. Notably,
  * this will not remove players (1), tears (2), familiars (3), lasers (7), knives (8), projectiles

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

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

package/dist/src/features/deployJSONRoom.lua

@@ -4,7 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
-local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, v
+local preUseItemWeNeedToGoDeeper, postNewRoomReordered, setDecorationsInvisible, respawnPersistentEntities, removeSpecificNPCs, fillRoomWithDecorations, spawnAllEntities, spawnGridEntityForJSONRoom, spawnNormalEntityForJSONRoom, storePersistentEntity, fixPitGraphics, getPitMap, getPitFrame, FEATURE_NAME, NPC_TYPES_TO_NOT_REMOVE, PERSISTENT_ENTITY_TYPES, GRID_ENTITY_XML_TYPE_SET, v
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local EffectVariant = ____isaac_2Dtypescript_2Ddefinitions.EffectVariant
@@ -13,6 +13,7 @@ local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
 local EntityGridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.EntityGridCollisionClass
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local GridEntityXMLType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityXMLType
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
 local PitfallVariant = ____isaac_2Dtypescript_2Ddefinitions.PitfallVariant
@@ -36,6 +37,8 @@ local ____entitiesSpecific = require("src.functions.entitiesSpecific")
 local getNPCs = ____entitiesSpecific.getNPCs
 local removeAllBombs = ____entitiesSpecific.removeAllBombs
 local removeAllPickups = ____entitiesSpecific.removeAllPickups
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
 local ____gridEntities = require("src.functions.gridEntities")
 local convertXMLGridEntityType = ____gridEntities.convertXMLGridEntityType
 local getAllGridIndexes = ____gridEntities.getAllGridIndexes
@@ -45,6 +48,7 @@ local removeGridEntity = ____gridEntities.removeGridEntity
 local setGridEntityInvisible = ____gridEntities.setGridEntityInvisible
 local spawnGridEntityWithVariant = ____gridEntities.spawnGridEntityWithVariant
 local ____jsonRoom = require("src.functions.jsonRoom")
+local getRandomJSONEntity = ____jsonRoom.getRandomJSONEntity
 local getRandomJSONRoom = ____jsonRoom.getRandomJSONRoom
 local ____log = require("src.functions.log")
 local log = ____log.log
@@ -219,29 +223,24 @@ function spawnAllEntities(self, jsonRoom, rng, verbose)
         if y == nil then
             error("Failed to convert the following y coordinate to a number (for a spawn): " .. yString)
         end
-        if #jsonSpawn.entity > 1 then
-            error("Stacked entities are not implemented for JSON rooms.")
-        end
-        local firstXMLEntity = jsonSpawn.entity[1]
-        if firstXMLEntity == nil then
-            error("Failed to get the first JSON entity from an \"entity\" array.")
-        end
-        local entityTypeString = firstXMLEntity["$"].type
+        local jsonEntity = getRandomJSONEntity(nil, jsonSpawn.entity)
+        local entityTypeString = jsonEntity["$"].type
         local entityTypeNumber = tonumber(entityTypeString)
         if entityTypeNumber == nil then
             error("Failed to convert the entity type to a number: " .. entityTypeString)
         end
-        local variantString = firstXMLEntity["$"].variant
+        local variantString = jsonEntity["$"].variant
         local variant = tonumber(variantString)
         if variant == nil then
             error("Failed to convert the entity variant to a number: " .. tostring(variant))
         end
-        local subTypeString = firstXMLEntity["$"].subtype
+        local subTypeString = jsonEntity["$"].subtype
         local subType = tonumber(subTypeString)
         if subType == nil then
             error("Failed to convert the entity sub-type to a number: " .. tostring(subType))
         end
-        if entityTypeNumber >= 1000 then
+        local isGridEntity = GRID_ENTITY_XML_TYPE_SET:has(entityTypeNumber)
+        if isGridEntity then
             local gridEntityXMLType = entityTypeNumber
             if verbose then
                 log(
@@ -465,6 +464,8 @@ end
 FEATURE_NAME = "deployJSONRoom"
 NPC_TYPES_TO_NOT_REMOVE = __TS__New(Set, {EntityType.DARK_ESAU})
 PERSISTENT_ENTITY_TYPES = __TS__New(Set, {EntityType.WALL_HUGGER})
+local gridEntityXMLTypes = getEnumValues(nil, GridEntityXMLType)
+GRID_ENTITY_XML_TYPE_SET = __TS__New(Set, gridEntityXMLTypes)
 v = {
     level = {
         deployedRoomListIndexes = __TS__New(Set),

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

@@ -1,5 +1,5 @@
 import { DoorSlotFlag } from "isaac-typescript-definitions";
-import { JSONRoom } from "../interfaces/JSONRoomsFile";
+import { JSONEntity, JSONRoom } from "../interfaces/JSONRoomsFile";
 /**
  * Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
  * given JSON room.
@@ -20,6 +20,20 @@ export declare function getJSONRoomOfVariant(jsonRooms: JSONRoom[] | readonly JS
  * @param subType The sub-type to match.
  */
 export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly JSONRoom[], subType: int): JSONRoom[];
+/**
+ * Helper function to get a random JSON entity from an array of JSON entities.
+ *
+ * Note that this function does not simply choose a random element in the provided array; it will
+ * properly account for each room weight using the algorithm from:
+ * https://stackoverflow.com/questions/1761626/weighted-random-numbers
+ *
+ * @param jsonEntities The array of entities to randomly choose between.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+ *                what the function is doing. Default is false.
+ */
+export declare function getRandomJSONEntity(jsonEntities: JSONEntity[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONEntity;
 /**
  * Helper function to get a random JSON room from an array of JSON rooms.
  *
@@ -27,11 +41,11 @@ export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly J
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
  *
- * @param jsonRooms The array of rooms to random choose between.
+ * @param jsonRooms The array of rooms to randomly choose between.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  *                what the function is doing. Default is false.
  */
-export declare function getRandomJSONRoom(jsonRooms: JSONRoom[] | readonly JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONRoom;
+export declare function getRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): JSONRoom;
 //# sourceMappingURL=jsonRoom.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"jsonRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/jsonRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAQvD;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,YAAY,CAAC,CAgDxB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,GAAG,SAAS,CAoBtB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,EAAE,CAMZ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,QAAQ,CAYV"}
+{"version":3,"file":"jsonRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/jsonRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAanE;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,YAAY,CAAC,CAgDxB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,GAAG,SAAS,CAoBtB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,EAAE,CAMZ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,UAAU,EAAE,EAC1B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,UAAU,CAoBZ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,QAAQ,CAiBV"}

package/dist/src/functions/jsonRoom.lua

@@ -2,7 +2,7 @@ local ____lualib = require("lualib_bundle")
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local ____exports = {}
-local getTotalWeightOfJSONRooms, getJSONRoomWithChosenWeight
+local getTotalWeightOfJSONObject, getJSONObjectWithChosenWeight
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local DoorSlotFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DoorSlotFlagZero
 local ____array = require("src.functions.array")
@@ -18,33 +18,34 @@ local ____random = require("src.functions.random")
 local getRandomFloat = ____random.getRandomFloat
 local ____rng = require("src.functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
-function getTotalWeightOfJSONRooms(self, jsonRooms)
+function getTotalWeightOfJSONObject(self, jsonOjectArray)
     local weights = __TS__ArrayMap(
-        jsonRooms,
-        function(____, jsonRoom)
-            local roomWeightString = jsonRoom["$"].weight
-            local roomWeight = tonumber(roomWeightString)
-            if roomWeight == nil then
-                error(("Failed to parse the weight of a JSON room: " .. roomWeightString) .. ".")
+        jsonOjectArray,
+        function(____, jsonObject)
+            local weightString = jsonObject["$"].weight
+            local weight = tonumber(weightString)
+            if weight == nil then
+                error(("Failed to parse the weight of a JSON object: " .. tostring(weightString)) .. ".")
             end
-            return roomWeight
+            return weight
         end
     )
     return sumArray(nil, weights)
 end
-function getJSONRoomWithChosenWeight(self, jsonRooms, chosenWeight)
-    for ____, jsonRoom in ipairs(jsonRooms) do
-        local roomWeightString = jsonRoom["$"].weight
-        local roomWeight = tonumber(roomWeightString)
-        if roomWeight == nil then
-            error("Failed to parse the weight of a JSON room: " .. roomWeightString)
+function getJSONObjectWithChosenWeight(self, jsonOjectArray, chosenWeight)
+    local weightAccumulator = 0
+    for ____, jsonObject in ipairs(jsonOjectArray) do
+        local weightString = jsonObject["$"].weight
+        local weight = tonumber(weightString)
+        if weight == nil then
+            error("Failed to parse the weight of a JSON object: " .. tostring(weightString))
         end
-        if chosenWeight < roomWeight then
-            return jsonRoom
+        weightAccumulator = weightAccumulator + weight
+        if weightAccumulator >= chosenWeight then
+            return jsonObject
         end
-        chosenWeight = chosenWeight - roomWeight
     end
-    error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
+    return nil
 end
 --- Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
 -- given JSON room.
@@ -122,13 +123,51 @@ function ____exports.getJSONRoomsOfSubType(self, jsonRooms, subType)
         end
     )
 end
+--- Helper function to get a random JSON entity from an array of JSON entities.
+-- 
+-- Note that this function does not simply choose a random element in the provided array; it will
+-- properly account for each room weight using the algorithm from:
+-- https://stackoverflow.com/questions/1761626/weighted-random-numbers
+-- 
+-- @param jsonEntities The array of entities to randomly choose between.
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+-- what the function is doing. Default is false.
+function ____exports.getRandomJSONEntity(self, jsonEntities, seedOrRNG, verbose)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if verbose == nil then
+        verbose = false
+    end
+    local totalWeight = getTotalWeightOfJSONObject(nil, jsonEntities)
+    if verbose then
+        log(
+            nil,
+            "Total weight of the JSON entities provided: " .. tostring(totalWeight)
+        )
+    end
+    local chosenWeight = getRandomFloat(nil, 0, totalWeight, seedOrRNG)
+    if verbose then
+        log(
+            nil,
+            "Randomly chose weight for JSON entity: " .. tostring(chosenWeight)
+        )
+    end
+    local randomJSONEntity = getJSONObjectWithChosenWeight(nil, jsonEntities, chosenWeight)
+    if randomJSONEntity == nil then
+        error("Failed to get a JSON entity with chosen weight: " .. tostring(chosenWeight))
+    end
+    return randomJSONEntity
+end
 --- Helper function to get a random JSON room from an array of JSON rooms.
 -- 
 -- Note that this function does not simply choose a random element in the provided array; it will
 -- properly account for each room weight using the algorithm from:
 -- https://stackoverflow.com/questions/1761626/weighted-random-numbers
 -- 
--- @param jsonRooms The array of rooms to random choose between.
+-- @param jsonRooms The array of rooms to randomly choose between.
 -- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
 -- `RNG.Next` method will be called. Default is `getRandomSeed()`.
 -- @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
@@ -140,7 +179,7 @@ function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
     if verbose == nil then
         verbose = false
     end
-    local totalWeight = getTotalWeightOfJSONRooms(nil, jsonRooms)
+    local totalWeight = getTotalWeightOfJSONObject(nil, jsonRooms)
     if verbose then
         log(
             nil,
@@ -154,6 +193,10 @@ function ____exports.getRandomJSONRoom(self, jsonRooms, seedOrRNG, verbose)
             "Randomly chose weight for JSON room: " .. tostring(chosenWeight)
         )
     end
-    return getJSONRoomWithChosenWeight(nil, jsonRooms, chosenWeight)
+    local randomJSONRoom = getJSONObjectWithChosenWeight(nil, jsonRooms, chosenWeight)
+    if randomJSONRoom == nil then
+        error("Failed to get a JSON room with chosen weight: " .. tostring(chosenWeight))
+    end
+    return randomJSONRoom
 end
 return ____exports

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

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

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

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

package/dist/src/functions/map.lua

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

package/dist/src/maps/gridEntityXMLMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gridEntityXMLMap.d.ts","sourceRoot":"","sources":["../../../src/maps/gridEntityXMLMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,iBAAiB,EAOlB,MAAM,8BAA8B,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAC3C,iBAAiB,EACjB;IAAC,cAAc;IAAE,GAAG;CAAC,CA6JrB,CAAC"}
+{"version":3,"file":"gridEntityXMLMap.d.ts","sourceRoot":"","sources":["../../../src/maps/gridEntityXMLMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,iBAAiB,EAOlB,MAAM,8BAA8B,CAAC;AAEtC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAC3C,iBAAiB,EACjB;IAAC,cAAc;IAAE,GAAG;CAAC,CAgKrB,CAAC"}

package/dist/src/maps/gridEntityXMLMap.lua

@@ -15,6 +15,7 @@ local TrapdoorVariant = ____isaac_2Dtypescript_2Ddefinitions.TrapdoorVariant
 --- This maps the GridEntityXMLType (i.e. the type contained in the room XML/STB file) to the
 -- GridEntityType and the variant used by the game.
 ____exports.GRID_ENTITY_XML_MAP = __TS__New(Map, {
+    {GridEntityXMLType.DECORATION, {GridEntityType.DECORATION, 0}},
     {GridEntityXMLType.ROCK, {GridEntityType.ROCK, RockVariant.NORMAL}},
     {GridEntityXMLType.ROCK_BOMB, {GridEntityType.ROCK_BOMB, 0}},
     {GridEntityXMLType.ROCK_ALT, {GridEntityType.ROCK_ALT, 0}},

package/package.json

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

package/src/features/deployJSONRoom.ts

@@ -36,6 +36,7 @@ import {
   removeAllBombs,
   removeAllPickups,
 } from "../functions/entitiesSpecific";
+import { getEnumValues } from "../functions/enums";
 import {
   convertXMLGridEntityType,
   getAllGridIndexes,
@@ -45,7 +46,7 @@ import {
   setGridEntityInvisible,
   spawnGridEntityWithVariant,
 } from "../functions/gridEntities";
-import { getRandomJSONRoom } from "../functions/jsonRoom";
+import { getRandomJSONEntity, getRandomJSONRoom } from "../functions/jsonRoom";
 import { log } from "../functions/log";
 import { getRandomSeed, isRNG, newRNG } from "../functions/rng";
 import { getRoomListIndex } from "../functions/roomData";
@@ -74,6 +75,11 @@ const PERSISTENT_ENTITY_TYPES: ReadonlySet<EntityType> = new Set([
   EntityType.WALL_HUGGER,
 ]);
 
+const gridEntityXMLTypes = getEnumValues(GridEntityXMLType);
+const GRID_ENTITY_XML_TYPE_SET: ReadonlySet<number> = new Set(
+  gridEntityXMLTypes,
+);
+
 const v = {
   level: {
     deployedRoomListIndexes: new Set<int>(),
@@ -310,7 +316,7 @@ export function deployJSONRoom(
  *                what the function is doing. Default is false.
  */
 export function deployRandomJSONRoom(
-  jsonRooms: JSONRoom[] | readonly JSONRoom[],
+  jsonRooms: JSONRoom[],
   seedOrRNG: Seed | RNG = getRandomSeed(),
   verbose = false,
 ): void {
@@ -463,16 +469,9 @@ function spawnAllEntities(
       );
     }
 
-    if (jsonSpawn.entity.length > 1) {
-      error("Stacked entities are not implemented for JSON rooms.");
-    }
-
-    const firstXMLEntity = jsonSpawn.entity[0];
-    if (firstXMLEntity === undefined) {
-      error('Failed to get the first JSON entity from an "entity" array.');
-    }
+    const jsonEntity = getRandomJSONEntity(jsonSpawn.entity);
 
-    const entityTypeString = firstXMLEntity.$.type;
+    const entityTypeString = jsonEntity.$.type;
     const entityTypeNumber = tonumber(entityTypeString);
     if (entityTypeNumber === undefined) {
       error(
@@ -480,20 +479,20 @@ function spawnAllEntities(
       );
     }
 
-    const variantString = firstXMLEntity.$.variant;
+    const variantString = jsonEntity.$.variant;
     const variant = tonumber(variantString);
     if (variant === undefined) {
       error(`Failed to convert the entity variant to a number: ${variant}`);
     }
 
-    const subTypeString = firstXMLEntity.$.subtype;
+    const subTypeString = jsonEntity.$.subtype;
     const subType = tonumber(subTypeString);
     if (subType === undefined) {
       error(`Failed to convert the entity sub-type to a number: ${subType}`);
     }
 
-    // Note that XML entity type 1000 is a rock, not an effect.
-    if (entityTypeNumber >= 1000) {
+    const isGridEntity = GRID_ENTITY_XML_TYPE_SET.has(entityTypeNumber);
+    if (isGridEntity) {
       const gridEntityXMLType = entityTypeNumber as GridEntityXMLType;
       if (verbose) {
         log(

package/src/functions/jsonRoom.ts

@@ -3,7 +3,7 @@ import {
   DoorSlotFlagZero,
   RoomShape,
 } from "isaac-typescript-definitions";
-import { JSONRoom } from "../interfaces/JSONRoomsFile";
+import { JSONEntity, JSONRoom } from "../interfaces/JSONRoomsFile";
 import { sumArray } from "./array";
 import { doorSlotToDoorSlotFlag, getRoomShapeDoorSlot } from "./doors";
 import { addFlag } from "./flag";
@@ -11,6 +11,11 @@ import { log } from "./log";
 import { getRandomFloat } from "./random";
 import { getRandomSeed } from "./rng";
 
+/** This represents either a `JSONRoom` or a `JSONEntity`. */
+interface JSONObject {
+  $: { weight: string | undefined };
+}
+
 /**
  * Helper function to calculate what the resulting `BitFlags<DoorSlotFlag>` value would be for a
  * given JSON room.
@@ -116,6 +121,45 @@ export function getJSONRoomsOfSubType(
   });
 }
 
+/**
+ * Helper function to get a random JSON entity from an array of JSON entities.
+ *
+ * Note that this function does not simply choose a random element in the provided array; it will
+ * properly account for each room weight using the algorithm from:
+ * https://stackoverflow.com/questions/1761626/weighted-random-numbers
+ *
+ * @param jsonEntities The array of entities to randomly choose between.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
+ *                what the function is doing. Default is false.
+ */
+export function getRandomJSONEntity(
+  jsonEntities: JSONEntity[],
+  seedOrRNG: Seed | RNG = getRandomSeed(),
+  verbose = false,
+): JSONEntity {
+  const totalWeight = getTotalWeightOfJSONObject(jsonEntities);
+  if (verbose) {
+    log(`Total weight of the JSON entities provided: ${totalWeight}`);
+  }
+
+  const chosenWeight = getRandomFloat(0, totalWeight, seedOrRNG);
+  if (verbose) {
+    log(`Randomly chose weight for JSON entity: ${chosenWeight}`);
+  }
+
+  const randomJSONEntity = getJSONObjectWithChosenWeight(
+    jsonEntities,
+    chosenWeight,
+  );
+  if (randomJSONEntity === undefined) {
+    error(`Failed to get a JSON entity with chosen weight: ${chosenWeight}`);
+  }
+
+  return randomJSONEntity;
+}
+
 /**
  * Helper function to get a random JSON room from an array of JSON rooms.
  *
@@ -123,18 +167,18 @@ export function getJSONRoomsOfSubType(
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
  *
- * @param jsonRooms The array of rooms to random choose between.
+ * @param jsonRooms The array of rooms to randomly choose between.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
  *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  *                what the function is doing. Default is false.
  */
 export function getRandomJSONRoom(
-  jsonRooms: JSONRoom[] | readonly JSONRoom[],
+  jsonRooms: JSONRoom[],
   seedOrRNG: Seed | RNG = getRandomSeed(),
   verbose = false,
 ): JSONRoom {
-  const totalWeight = getTotalWeightOfJSONRooms(jsonRooms);
+  const totalWeight = getTotalWeightOfJSONObject(jsonRooms);
   if (verbose) {
     log(`Total weight of the JSON rooms provided: ${totalWeight}`);
   }
@@ -144,41 +188,46 @@ export function getRandomJSONRoom(
     log(`Randomly chose weight for JSON room: ${chosenWeight}`);
   }
 
-  return getJSONRoomWithChosenWeight(jsonRooms, chosenWeight);
+  const randomJSONRoom = getJSONObjectWithChosenWeight(jsonRooms, chosenWeight);
+  if (randomJSONRoom === undefined) {
+    error(`Failed to get a JSON room with chosen weight: ${chosenWeight}`);
+  }
+
+  return randomJSONRoom;
 }
 
-function getTotalWeightOfJSONRooms(
-  jsonRooms: JSONRoom[] | readonly JSONRoom[],
-): float {
-  const weights = jsonRooms.map((jsonRoom) => {
-    const roomWeightString = jsonRoom.$.weight;
-    const roomWeight = tonumber(roomWeightString);
-    if (roomWeight === undefined) {
-      error(`Failed to parse the weight of a JSON room: ${roomWeightString}.`);
+function getTotalWeightOfJSONObject(jsonOjectArray: JSONObject[]): float {
+  const weights = jsonOjectArray.map((jsonObject) => {
+    const weightString = jsonObject.$.weight;
+    const weight = tonumber(weightString);
+    if (weight === undefined) {
+      error(`Failed to parse the weight of a JSON object: ${weightString}.`);
     }
-    return roomWeight;
+
+    return weight;
   });
 
   return sumArray(weights);
 }
 
-function getJSONRoomWithChosenWeight(
-  jsonRooms: JSONRoom[] | readonly JSONRoom[],
+function getJSONObjectWithChosenWeight<T extends JSONObject>(
+  jsonOjectArray: T[],
   chosenWeight: float,
-): JSONRoom {
-  for (const jsonRoom of jsonRooms) {
-    const roomWeightString = jsonRoom.$.weight;
-    const roomWeight = tonumber(roomWeightString);
-    if (roomWeight === undefined) {
-      error(`Failed to parse the weight of a JSON room: ${roomWeightString}`);
+): T | undefined {
+  let weightAccumulator = 0;
+
+  for (const jsonObject of jsonOjectArray) {
+    const weightString = jsonObject.$.weight;
+    const weight = tonumber(weightString);
+    if (weight === undefined) {
+      error(`Failed to parse the weight of a JSON object: ${weightString}`);
     }
 
-    if (chosenWeight < roomWeight) {
-      return jsonRoom;
+    weightAccumulator += weight;
+    if (weightAccumulator >= chosenWeight) {
+      return jsonObject;
     }
-
-    chosenWeight -= roomWeight;
   }
 
-  error(`Failed to get a JSON room with chosen weight: ${chosenWeight}`);
+  return undefined;
 }

package/src/functions/map.ts

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

package/src/maps/gridEntityXMLMap.ts

@@ -18,6 +18,9 @@ export const GRID_ENTITY_XML_MAP: ReadonlyMap<
   GridEntityXMLType,
   [GridEntityType, int]
 > = new Map([
+  // 0
+  [GridEntityXMLType.DECORATION, [GridEntityType.DECORATION, 0]],
+
   // 1000
   [GridEntityXMLType.ROCK, [GridEntityType.ROCK, RockVariant.NORMAL]],