isaacscript-common 12.5.2 → 12.6.0

package/dist/index.d.ts

@@ -1779,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
@@ -4527,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.
  *
@@ -4534,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.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 12.5.2
+isaacscript-common 12.6.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19235,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}},
@@ -40810,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")
@@ -40826,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
@@ -40919,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)
@@ -40926,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,
@@ -40940,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,
@@ -41298,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
@@ -41464,24 +41498,18 @@ 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))

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":";;AAwDA,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AA4KvD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,EACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAuBN;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,IAAI,CAaN;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAwB5D"}
+{"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

@@ -48,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
@@ -222,24 +223,18 @@ 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))

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/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.2",
+  "version": "12.6.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/features/deployJSONRoom.ts

@@ -46,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";
@@ -316,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 {
@@ -469,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(
@@ -486,13 +479,13 @@ 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}`);

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/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]],