isaacscript-common 6.13.0 → 6.16.0

package/dist/functions/kColor.lua

@@ -2,11 +2,15 @@ local ____exports = {}
 local OBJECT_NAME
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
-local ____SerializationType = require("enums.SerializationType")
-local SerializationType = ____SerializationType.SerializationType
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
 local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
+local ____random = require("functions.random")
+local getRandom = ____random.getRandom
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+local newRNG = ____rng.newRNG
 local ____table = require("functions.table")
 local copyValuesToTable = ____table.copyValuesToTable
 local getNumbersFromTable = ____table.getNumbersFromTable
@@ -19,66 +23,56 @@ function ____exports.isKColor(self, object)
 end
 local KEYS = {"Red", "Green", "Blue", "Alpha"}
 OBJECT_NAME = "KColor"
---- Helper function to copy a `KColor` object.
+--- Helper function to copy a `KColor` Isaac API class.
+function ____exports.copyKColor(self, kColor)
+    if not ____exports.isKColor(nil, kColor) then
+        error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    return KColor(kColor.Red, kColor.Green, kColor.Blue, kColor.Alpha)
+end
+--- Helper function to convert a `SerializedKColor` object to a normal `KColor` object. (This is used
+-- by the save data manager when reading data from the "save#.dat" file.)
+function ____exports.deserializeKColor(self, kColor)
+    if not isTable(nil, kColor) then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+    end
+    local r, g, b, a = table.unpack(getNumbersFromTable(
+        nil,
+        kColor,
+        OBJECT_NAME,
+        table.unpack(KEYS)
+    ))
+    if r == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Red")
+    end
+    if g == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Green")
+    end
+    if b == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Blue")
+    end
+    if a == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: Alpha")
+    end
+    return KColor(r, g, b, a)
+end
+--- Helper function to get a random color.
 -- 
--- @param kColor The KColor object to copy. In the case of deserialization, this will actually be a
--- Lua table instead of an instantiated KColor class.
--- @param serializationType Default is `SerializationType.NONE`.
-function ____exports.copyKColor(self, kColor, serializationType)
-    if serializationType == nil then
-        serializationType = SerializationType.NONE
+-- @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 alpha Optional. The alpha value to use. Default is 1.
+function ____exports.getRandomKColor(self, seedOrRNG, alpha)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
     end
-    repeat
-        local ____switch3 = serializationType
-        local ____cond3 = ____switch3 == SerializationType.NONE
-        if ____cond3 then
-            do
-                if not ____exports.isKColor(nil, kColor) then
-                    error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                return KColor(kColor.Red, kColor.Green, kColor.Blue, kColor.Alpha)
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.SERIALIZE
-        if ____cond3 then
-            do
-                if not ____exports.isKColor(nil, kColor) then
-                    error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                local kColorTable = {}
-                copyValuesToTable(nil, kColor, KEYS, kColorTable)
-                kColorTable[SerializationBrand.K_COLOR] = ""
-                return kColorTable
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
-        if ____cond3 then
-            do
-                if not isTable(nil, kColor) then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
-                end
-                local r, g, b, a = table.unpack(getNumbersFromTable(
-                    nil,
-                    kColor,
-                    OBJECT_NAME,
-                    table.unpack(KEYS)
-                ))
-                if r == nil then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: r")
-                end
-                if g == nil then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: g")
-                end
-                if b == nil then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: b")
-                end
-                if a == nil then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: a")
-                end
-                return KColor(r, g, b, a)
-            end
-        end
-    until true
+    if alpha == nil then
+        alpha = 1
+    end
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
+    local r = getRandom(nil, rng)
+    local g = getRandom(nil, rng)
+    local b = getRandom(nil, rng)
+    return KColor(r, g, b, alpha)
 end
 --- Used to determine is the given table is a serialized `KColor` object created by the save data
 -- manager and/or the `deepCopy` function.
@@ -95,4 +89,15 @@ end
 function ____exports.kColorEquals(self, kColor1, kColor2)
     return isaacAPIClassEquals(nil, kColor1, kColor2, KEYS)
 end
+--- Helper function to convert a `KColor` object to a `SerializedKColor` object. (This is used by the
+-- save data manager when writing data from the "save#.dat" file.)
+function ____exports.serializeKColor(self, kColor)
+    if not ____exports.isKColor(nil, kColor) then
+        error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    local kColorTable = {}
+    copyValuesToTable(nil, kColor, KEYS, kColorTable)
+    kColorTable[SerializationBrand.K_COLOR] = ""
+    return kColorTable
+end
 return ____exports

package/dist/functions/mergeTests.lua

@@ -19,8 +19,8 @@ local newRNG = ____rng.newRNG
 local ____serialization = require("functions.serialization")
 local isSerializedIsaacAPIClass = ____serialization.isSerializedIsaacAPIClass
 local ____vector = require("functions.vector")
-local copyVector = ____vector.copyVector
 local isVector = ____vector.isVector
+local serializeVector = ____vector.serializeVector
 function oldTableHasUpdatedValue(self)
     local key = "foo"
     local oldValue = "bar"
@@ -60,7 +60,7 @@ function oldTableHasSerializedIsaacAPIClass(self)
     local x = 50
     local y = 60
     local vector = Vector(x, y)
-    local vectorSerialized = copyVector(nil, vector, SerializationType.SERIALIZE)
+    local vectorSerialized = serializeVector(nil, vector)
     if not isSerializedIsaacAPIClass(nil, vectorSerialized) then
         error("The \"isSerializedIsaacAPIClass\" function says that a serialized vector is not serialized.")
     end

package/dist/functions/npcs.d.ts

@@ -1,18 +1,4 @@
-import { EntityType, ProjectilesMode } from "isaac-typescript-definitions";
-/**
- * Helper function to make an NPC fire a projectile. Returns the fired projectile. Use this function
- * instead of the `EntityNPC.FireProjectiles` method, since that returns void.
- *
- * @param npc The NPC to fire the projectile from.
- * @param position The staring position of the projectile.
- * @param velocity The starting velocity of the projectile.
- * @param projectilesMode The mode of the projectile. Optional. Default is
- *                        `ProjectilesMode.ONE_PROJECTILE`.
- * @param projectileParams The parameters of the projectile. Optional. Default is
- *                         `ProjectileParams()`.
- * @returns The fired projectile.
- */
-export declare function fireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode?: ProjectilesMode, projectileParams?: ProjectileParams): EntityProjectile[];
+import { EntityType } from "isaac-typescript-definitions";
 /**
  * Helper function to get all of the non-dead NPCs in the room.
  *
@@ -46,18 +32,4 @@ export declare function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean;
  * enemies.
  */
 export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
-/**
- * The base game `EntityNPC.FireProjectiles` method does not return anything, which is a problem in
- * situations where you need to work with the fired projectiles. This function invokes that method,
- * and then returns the projectiles that were spawned.
- *
- * @param npc The EntityNPC firing projectiles.
- * @param position The starting position of the projectiles.
- * @param velocity The starting velocity of the projectiles.
- * @param projectilesMode A ProjectilesMode enum value defining how to fire the projectiles.
- * @param projectileParams A ProjectileParams object containing various parameters for the
- *                         projectiles.
- * @returns An array of EntityProjectiles containing all fired projectiles.
- */
-export declare function npcFireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode: ProjectilesMode, projectileParams: ProjectileParams): EntityProjectile[];
 //# sourceMappingURL=npcs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"npcs.d.ts","sourceRoot":"","sources":["../../src/functions/npcs.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,UAAU,EAMV,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAgCtC;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,eAAe,GAAE,eAAgD,EACjE,gBAAgB,GAAE,gBAAqC,GACtD,gBAAgB,EAAE,CAMpB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAC1B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAoB3D;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAKpE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAO3D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,SAAS,EACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,eAAe,EAChC,gBAAgB,EAAE,gBAAgB,GACjC,gBAAgB,EAAE,CAOpB"}
+{"version":3,"file":"npcs.d.ts","sourceRoot":"","sources":["../../src/functions/npcs.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,UAAU,EAQX,MAAM,8BAA8B,CAAC;AA+BtC;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAC1B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,SAAS,EAAE,CAGb;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAoB3D;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAKpE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAO3D"}

package/dist/functions/npcs.lua

@@ -17,16 +17,12 @@ local MotherSubType = ____isaac_2Dtypescript_2Ddefinitions.MotherSubType
 local MotherVariant = ____isaac_2Dtypescript_2Ddefinitions.MotherVariant
 local NpcState = ____isaac_2Dtypescript_2Ddefinitions.NpcState
 local PeepVariant = ____isaac_2Dtypescript_2Ddefinitions.PeepVariant
-local ProjectilesMode = ____isaac_2Dtypescript_2Ddefinitions.ProjectilesMode
 local RaglingVariant = ____isaac_2Dtypescript_2Ddefinitions.RaglingVariant
 local VisVariant = ____isaac_2Dtypescript_2Ddefinitions.VisVariant
 local ____constants = require("constants")
 local EGGY_STATE_FRAME_OF_FINAL_SPIDER = ____constants.EGGY_STATE_FRAME_OF_FINAL_SPIDER
-local ____entities = require("functions.entities")
-local getFilteredNewEntities = ____entities.getFilteredNewEntities
 local ____entitiesSpecific = require("functions.entitiesSpecific")
 local getNPCs = ____entitiesSpecific.getNPCs
-local getProjectiles = ____entitiesSpecific.getProjectiles
 --- Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should
 -- not actually keep the doors closed (like Death's scythes).
 function ____exports.isAliveExceptionNPC(self, npc)
@@ -82,29 +78,6 @@ NON_ALIVE_NPCS_TYPE_VARIANT_SUBTYPE = __TS__New(
         (((tostring(EntityType.MOTHER) .. ".") .. tostring(MotherVariant.MOTHER_1)) .. ".") .. tostring(MotherSubType.PHASE_2)
     }
 )
---- Helper function to make an NPC fire a projectile. Returns the fired projectile. Use this function
--- instead of the `EntityNPC.FireProjectiles` method, since that returns void.
--- 
--- @param npc The NPC to fire the projectile from.
--- @param position The staring position of the projectile.
--- @param velocity The starting velocity of the projectile.
--- @param projectilesMode The mode of the projectile. Optional. Default is
--- `ProjectilesMode.ONE_PROJECTILE`.
--- @param projectileParams The parameters of the projectile. Optional. Default is
--- `ProjectileParams()`.
--- @returns The fired projectile.
-function ____exports.fireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
-    if projectilesMode == nil then
-        projectilesMode = ProjectilesMode.ONE_PROJECTILE
-    end
-    if projectileParams == nil then
-        projectileParams = ProjectileParams()
-    end
-    local oldProjectiles = getProjectiles(nil, projectileParams.Variant)
-    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
-    local newProjectiles = getProjectiles(nil, projectileParams.Variant)
-    return getFilteredNewEntities(nil, oldProjectiles, newProjectiles)
-end
 --- Helper function to get all of the non-dead NPCs in the room.
 -- 
 -- This function will not include NPCs on an internal blacklist, such as Death's scythes or Big Horn
@@ -142,22 +115,4 @@ function ____exports.getAliveNPCs(self, entityType, variant, subType, ignoreFrie
         function(____, npc) return not npc:IsDead() and not ____exports.isAliveExceptionNPC(nil, npc) end
     )
 end
---- The base game `EntityNPC.FireProjectiles` method does not return anything, which is a problem in
--- situations where you need to work with the fired projectiles. This function invokes that method,
--- and then returns the projectiles that were spawned.
--- 
--- @param npc The EntityNPC firing projectiles.
--- @param position The starting position of the projectiles.
--- @param velocity The starting velocity of the projectiles.
--- @param projectilesMode A ProjectilesMode enum value defining how to fire the projectiles.
--- @param projectileParams A ProjectileParams object containing various parameters for the
--- projectiles.
--- @returns An array of EntityProjectiles containing all fired projectiles.
-function ____exports.npcFireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
-    local oldEntities = getProjectiles(nil)
-    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
-    local newEntities = getProjectiles(nil)
-    local filteredNewEntities = getFilteredNewEntities(nil, oldEntities, newEntities)
-    return filteredNewEntities
-end
 return ____exports

package/dist/functions/projectiles.d.ts

@@ -0,0 +1,32 @@
+import { ProjectilesMode } from "isaac-typescript-definitions";
+/**
+ * Helper function to make an NPC fire one or more projectiles. Returns the fired projectile(s).
+ *
+ * Use this function instead of the `EntityNPC.FireProjectiles` method if you need to modify or
+ * access the `EntityProjectile` objects after they are fired, since this function returns the
+ * objects in an array.
+ *
+ * @param npc The NPC to fire the projectile(s) from. You can also pass undefined if you do not want
+ *            the projectile(s) to come from anything in particular.
+ * @param position The staring position of the projectile(s).
+ * @param velocity The starting velocity of the projectile(s).
+ * @param projectilesMode Optional. The mode of the projectile(s). Default is
+ *                        `ProjectilesMode.ONE_PROJECTILE`.
+ * @param projectileParams Optional. The parameters of the projectile(s). Default is
+ *                         `ProjectileParams()`.
+ * @returns The fired projectile(s).
+ */
+export declare function fireProjectiles(npc: EntityNPC | undefined, position: Vector, velocity: Vector, projectilesMode?: ProjectilesMode, projectileParams?: ProjectileParams): EntityProjectile[];
+/**
+ * Helper function to spawn projectiles in a circle around a position. Under the hood, this
+ * leverages `ProjectileMode.N_PROJECTILES_IN_CIRCLE`.
+ *
+ * @param npc The NPC to fire the projectile(s) from. You can also pass undefined if you do not want
+ *            the projectile(s) to come from anything in particular.
+ * @param position The staring position of the projectile(s).
+ * @param speed The speed of the projectile(s).
+ * @param numProjectiles The amount of projectiles to spawn.
+ * @returns The fired projectile(s).
+ */
+export declare function fireProjectilesInCircle(npc: EntityNPC | undefined, position: Vector, speed: float, numProjectiles: int): EntityProjectile[];
+//# sourceMappingURL=projectiles.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"projectiles.d.ts","sourceRoot":"","sources":["../../src/functions/projectiles.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,eAAe,EAChB,MAAM,8BAA8B,CAAC;AAItC;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,SAAS,GAAG,SAAS,EAC1B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,eAAe,GAAE,eAAgD,EACjE,gBAAgB,GAAE,gBAAqC,GACtD,gBAAgB,EAAE,CAoBpB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,SAAS,GAAG,SAAS,EAC1B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,KAAK,EACZ,cAAc,EAAE,GAAG,GAClB,gBAAgB,EAAE,CAQpB"}

package/dist/functions/projectiles.lua

@@ -0,0 +1,73 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local ProjectilesMode = ____isaac_2Dtypescript_2Ddefinitions.ProjectilesMode
+local ____entities = require("functions.entities")
+local getFilteredNewEntities = ____entities.getFilteredNewEntities
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local getProjectiles = ____entitiesSpecific.getProjectiles
+local spawnNPC = ____entitiesSpecific.spawnNPC
+--- Helper function to make an NPC fire one or more projectiles. Returns the fired projectile(s).
+-- 
+-- Use this function instead of the `EntityNPC.FireProjectiles` method if you need to modify or
+-- access the `EntityProjectile` objects after they are fired, since this function returns the
+-- objects in an array.
+-- 
+-- @param npc The NPC to fire the projectile(s) from. You can also pass undefined if you do not want
+-- the projectile(s) to come from anything in particular.
+-- @param position The staring position of the projectile(s).
+-- @param velocity The starting velocity of the projectile(s).
+-- @param projectilesMode Optional. The mode of the projectile(s). Default is
+-- `ProjectilesMode.ONE_PROJECTILE`.
+-- @param projectileParams Optional. The parameters of the projectile(s). Default is
+-- `ProjectileParams()`.
+-- @returns The fired projectile(s).
+function ____exports.fireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
+    if projectilesMode == nil then
+        projectilesMode = ProjectilesMode.ONE_PROJECTILE
+    end
+    if projectileParams == nil then
+        projectileParams = ProjectileParams()
+    end
+    local oldProjectiles = getProjectiles(nil, projectileParams.Variant)
+    local spawnedFly = false
+    if npc == nil then
+        spawnedFly = true
+        npc = spawnNPC(
+            nil,
+            EntityType.FLY,
+            0,
+            0,
+            position
+        )
+        npc.Visible = false
+        npc:ClearEntityFlags(EntityFlag.APPEAR)
+    end
+    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
+    local newProjectiles = getProjectiles(nil, projectileParams.Variant)
+    if spawnedFly then
+        npc:Remove()
+    end
+    return getFilteredNewEntities(nil, oldProjectiles, newProjectiles)
+end
+--- Helper function to spawn projectiles in a circle around a position. Under the hood, this
+-- leverages `ProjectileMode.N_PROJECTILES_IN_CIRCLE`.
+-- 
+-- @param npc The NPC to fire the projectile(s) from. You can also pass undefined if you do not want
+-- the projectile(s) to come from anything in particular.
+-- @param position The staring position of the projectile(s).
+-- @param speed The speed of the projectile(s).
+-- @param numProjectiles The amount of projectiles to spawn.
+-- @returns The fired projectile(s).
+function ____exports.fireProjectilesInCircle(self, npc, position, speed, numProjectiles)
+    local velocity = Vector(speed, numProjectiles)
+    return ____exports.fireProjectiles(
+        nil,
+        npc,
+        position,
+        velocity,
+        ProjectilesMode.N_PROJECTILES_IN_CIRCLE
+    )
+end
+return ____exports

package/dist/functions/random.d.ts

@@ -27,7 +27,7 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
 /**
  * This returns a random integer between min and max. It is inclusive on both ends.
  *
- * Note that this function will invoke the `Next` method on the `RNG` object before returning the
+ * Note that this function will run the `Next` method on the `RNG` object before returning the
  * random number.
  *
  * For example:

package/dist/functions/random.lua

@@ -44,7 +44,7 @@ function ____exports.getRandomFloat(self, min, max, seedOrRNG)
 end
 --- This returns a random integer between min and max. It is inclusive on both ends.
 -- 
--- Note that this function will invoke the `Next` method on the `RNG` object before returning the
+-- Note that this function will run the `Next` method on the `RNG` object before returning the
 -- random number.
 -- 
 -- For example:

package/dist/functions/rng.d.ts

@@ -1,24 +1,16 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
-import { SerializationType } from "../enums/SerializationType";
-declare type SerializedRNG = LuaMap<string, unknown> & {
+export declare type SerializedRNG = LuaMap<string, unknown> & {
     readonly __serializedRNGBrand: symbol;
 };
-interface CopyRNGReturn {
-    [SerializationType.NONE]: RNG;
-    [SerializationType.SERIALIZE]: SerializedRNG;
-    [SerializationType.DESERIALIZE]: RNG;
-}
+/** Helper function to copy an `RNG` Isaac API class. */
+export declare function copyRNG(rng: RNG): RNG;
 /**
- * Helper function to copy an `RNG` object.
- *
- * @param rng The RNG object to copy. In the case of deserialization, this will actually be a Lua
- *            table instead of an instantiated RNG class.
- * @param serializationType Default is `SerializationType.NONE`.
+ * Helper function to convert a `SerializedRNG` object to a normal `RNG` object. (This is used by
+ * the save data manager when reading data from the "save#.dat" file.)
  */
-export declare function copyRNG<R extends RNG | SerializedRNG, S extends SerializationType>(rng: R, serializationType: S): CopyRNGReturn[S];
-export declare function copyRNG<R extends RNG | SerializedRNG>(rng: R): CopyRNGReturn[SerializationType.NONE];
+export declare function deserializeRNG(rng: SerializedRNG): RNG;
 /**
  * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
  * instead of calling the `Random` function directly since that can return a value of 0 and crash
@@ -39,6 +31,11 @@ export declare function isSerializedRNG(object: unknown): object is SerializedRN
  */
 export declare function newRNG(seed?: Seed): RNG;
 export declare function rngEquals(rng1: RNG, rng2: RNG): boolean;
+/**
+ * Helper function to convert a `RNG` object to a `SerializedRNG` object. (This is used by the save
+ * data manager when writing data from the "save#.dat" file.)
+ */
+export declare function serializeRNG(rng: RNG): SerializedRNG;
 /**
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to a particular seed.
@@ -51,5 +48,4 @@ export declare function setAllRNGToSeed(object: unknown, seed: Seed): void;
 export declare function setAllRNGToStartSeed(object: unknown): void;
 /** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
 export declare function setSeed(rng: RNG, seed: Seed): void;
-export {};
 //# sourceMappingURL=rng.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rng.d.ts","sourceRoot":"","sources":["../../src/functions/rng.ts"],"names":[],"mappings":";;;AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,aAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC7C,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC,CAAC;AAEF,UAAU,aAAa;IACrB,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;IAC9B,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC7C,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;CACtC;AAYD;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,CAAC,SAAS,GAAG,GAAG,aAAa,EAC7B,CAAC,SAAS,iBAAiB,EAC3B,GAAG,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAClD,wBAAgB,OAAO,CAAC,CAAC,SAAS,GAAG,GAAG,aAAa,EACnD,GAAG,EAAE,CAAC,GACL,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAiDzC;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,2EAA2E;AAC3E,wBAAgB,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAEpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,OAAkB,GAAG,GAAG,CAIlD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAEvD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAoBjE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAK1D;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CASlD"}
+{"version":3,"file":"rng.d.ts","sourceRoot":"","sources":["../../src/functions/rng.ts"],"names":[],"mappings":";;;AAMA,oBAAY,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACpD,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC,CAAC;AAYF,wDAAwD;AACxD,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CASrC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,aAAa,GAAG,GAAG,CAatD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,2EAA2E;AAC3E,wBAAgB,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAEpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,OAAkB,GAAG,GAAG,CAIlD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAEvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,aAAa,CAYpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAoBjE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAK1D;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CASlD"}

package/dist/functions/rng.lua

@@ -6,8 +6,6 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
-local ____SerializationType = require("enums.SerializationType")
-local SerializationType = ____SerializationType.SerializationType
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
 local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
@@ -49,57 +47,27 @@ end
 RECOMMENDED_SHIFT_IDX = 35
 local KEYS = {"seed"}
 OBJECT_NAME = "RNG"
---- Helper function to copy an `RNG` object.
--- 
--- @param rng The RNG object to copy. In the case of deserialization, this will actually be a Lua
--- table instead of an instantiated RNG class.
--- @param serializationType Default is `SerializationType.NONE`.
-function ____exports.copyRNG(self, rng, serializationType)
-    if serializationType == nil then
-        serializationType = SerializationType.NONE
+--- Helper function to copy an `RNG` Isaac API class.
+function ____exports.copyRNG(self, rng)
+    if not ____exports.isRNG(nil, rng) then
+        error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
     end
-    repeat
-        local ____switch3 = serializationType
-        local ____cond3 = ____switch3 == SerializationType.NONE
-        if ____cond3 then
-            do
-                if not ____exports.isRNG(nil, rng) then
-                    error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                local seed = rng:GetSeed()
-                return ____exports.newRNG(nil, seed)
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.SERIALIZE
-        if ____cond3 then
-            do
-                if not ____exports.isRNG(nil, rng) then
-                    error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                local seed = rng:GetSeed()
-                local rngTable = {}
-                rngTable.seed = seed
-                rngTable[SerializationBrand.RNG] = ""
-                return rngTable
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
-        if ____cond3 then
-            do
-                if not isTable(nil, rng) then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
-                end
-                local seedNumber = table.unpack(getNumbersFromTable(
-                    nil,
-                    rng,
-                    OBJECT_NAME,
-                    table.unpack(KEYS)
-                ))
-                local seed = seedNumber
-                return ____exports.newRNG(nil, seed)
-            end
-        end
-    until true
+    local seed = rng:GetSeed()
+    return ____exports.newRNG(nil, seed)
+end
+--- Helper function to convert a `SerializedRNG` object to a normal `RNG` object. (This is used by
+-- the save data manager when reading data from the "save#.dat" file.)
+function ____exports.deserializeRNG(self, rng)
+    if not isTable(nil, rng) then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+    end
+    local seed = table.unpack(getNumbersFromTable(
+        nil,
+        rng,
+        OBJECT_NAME,
+        table.unpack(KEYS)
+    ))
+    return ____exports.newRNG(nil, seed)
 end
 --- Used to determine is the given table is a serialized `RNG` object created by the save data
 -- manager and/or the `deepCopy` function.
@@ -116,6 +84,18 @@ end
 function ____exports.rngEquals(self, rng1, rng2)
     return isaacAPIClassEquals(nil, rng1, rng2, KEYS)
 end
+--- Helper function to convert a `RNG` object to a `SerializedRNG` object. (This is used by the save
+-- data manager when writing data from the "save#.dat" file.)
+function ____exports.serializeRNG(self, rng)
+    if not ____exports.isRNG(nil, rng) then
+        error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    local seed = rng:GetSeed()
+    local rngTable = {}
+    rngTable.seed = seed
+    rngTable[SerializationBrand.RNG] = ""
+    return rngTable
+end
 --- Helper function to iterate over the provided object and set the seed for all of the values that
 -- are RNG objects equal to a particular seed.
 function ____exports.setAllRNGToSeed(self, object, seed)

package/dist/functions/rockAlt.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+import { RockAltType } from "../enums/RockAltType";
+/**
+ * Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
+ * will have.
+ *
+ * The rock type is based on the backdrop of the room.
+ *
+ * For example, if you change the backdrop of the starting room of the run to `BackdropType.CAVES`,
+ * and then spawn `GridEntityType.ROCK_ALT`, it will be a mushroom instead of an urn. Additionally,
+ * if it is destroyed, it will generate mushroom-appropriate rewards.
+ *
+ * On the other hand, if an urn is spawned first before the backdrop is changed to
+ * `BackdropType.CAVES`, the graphic of the urn will not switch to a mushroom. However, when
+ * destroyed, the urn will still generate mushroom-appropriate rewards.
+ */
+export declare function getRockAltType(): RockAltType;
+/**
+ * Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
+ * breaks.
+ *
+ * Most of the time, this function will do nothing, similar to how most of the time, when an
+ * individual urn is destroyed, nothing will spawn.
+ *
+ * Note that in vanilla, trinkets will not spawn if they have already been removed from the trinket
+ * pool. This function cannot replicate that behavior because there is no way to check to see if a
+ * trinket is still in the pool. Thus, it will always have a chance to spawn the respective trinket
+ * (e.g. Swallowed Penny from urns).
+ *
+ * The logic in this function is based on the rewards listed on the wiki:
+ * https://bindingofisaacrebirth.fandom.com/wiki/Rocks
+ *
+ * @param position The place to spawn the reward.
+ * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
+ *                    at spawning coins and spiders.
+ * @param variant Optional. The variant of the grid entity to emulate. Default is 0, which
+ *                corresponds to a "normal" grid entity or an empty bucket. This only matters when
+ *                spawning the reward for buckets. (Empty buckets have different rewards than full
+ *                buckets.)
+ * @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()`. Normally, you
+ *                  should pass the `InitSeed` of the grid entity that was broken.
+ * @returns Whether or not this function spawned something.
+ */
+export declare function spawnRockAltReward(position: Vector, rockAltType: RockAltType, variant?: number, seedOrRNG?: Seed | RNG): boolean;
+//# sourceMappingURL=rockAlt.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AA+BnD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,OAAO,SAAI,EACX,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CAwBT"}