isaacscript-common 6.15.0 → 6.16.2

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

@@ -2,12 +2,32 @@
 /// <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.
  *
- * Note that 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.
+ * 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
@@ -15,10 +35,14 @@ import { RockAltType } from "../enums/RockAltType";
  * @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, seedOrRNG?: Seed | RNG): boolean;
+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

@@ -1 +1 @@
-{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAgBnD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CAwBT"}
+{"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"}

package/dist/functions/rockAlt.lua

@@ -1,5 +1,5 @@
 local ____exports = {}
-local spawnRockAltRewardUrn, spawnRockAltRewardMushroom, spawnRockAltRewardSkull, spawnRockAltRewardPolyp, spawnRockAltRewardBucket
+local spawnRockAltRewardUrn, spawnRockAltRewardMushroom, spawnRockAltRewardSkull, spawnRockAltRewardPolyp, spawnRockAltRewardBucket, ROCK_ALT_CHANCES, POLYP_PROJECTILE_SPEED, POLYP_NUM_PROJECTILES
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Card = ____isaac_2Dtypescript_2Ddefinitions.Card
 local CoinSubType = ____isaac_2Dtypescript_2Ddefinitions.CoinSubType
@@ -17,6 +17,8 @@ local ____constants = require("constants")
 local DISTANCE_OF_GRID_TILE = ____constants.DISTANCE_OF_GRID_TILE
 local ____RockAltType = require("enums.RockAltType")
 local RockAltType = ____RockAltType.RockAltType
+local ____backdropTypeToRockAltType = require("objects.backdropTypeToRockAltType")
+local BACKDROP_TYPE_TO_ROCK_ALT_TYPE = ____backdropTypeToRockAltType.BACKDROP_TYPE_TO_ROCK_ALT_TYPE
 local ____entitiesSpecific = require("functions.entitiesSpecific")
 local spawnEffectWithSeed = ____entitiesSpecific.spawnEffectWithSeed
 local spawnNPCWithSeed = ____entitiesSpecific.spawnNPCWithSeed
@@ -28,6 +30,8 @@ local spawnCoinWithSeed = ____pickupsSpecific.spawnCoinWithSeed
 local spawnHeartWithSeed = ____pickupsSpecific.spawnHeartWithSeed
 local spawnPillWithSeed = ____pickupsSpecific.spawnPillWithSeed
 local spawnTrinketWithSeed = ____pickupsSpecific.spawnTrinketWithSeed
+local ____projectiles = require("functions.projectiles")
+local fireProjectilesInCircle = ____projectiles.fireProjectilesInCircle
 local ____random = require("functions.random")
 local getRandom = ____random.getRandom
 local ____rng = require("functions.rng")
@@ -43,11 +47,11 @@ local getRandomVector = ____vector.getRandomVector
 function spawnRockAltRewardUrn(self, position, rng)
     local chance = getRandom(nil, rng)
     local totalChance = 0
-    totalChance = totalChance + 0.68
+    totalChance = totalChance + ROCK_ALT_CHANCES.Nothing
     if chance < totalChance then
         return false
     end
-    totalChance = totalChance + 0.0944
+    totalChance = totalChance + ROCK_ALT_CHANCES.BasicDrop
     if chance < totalChance then
         local numCoinsChance = getRandom(nil, rng)
         local numCoins = numCoinsChance < 0.5 and 1 or 2
@@ -69,12 +73,12 @@ function spawnRockAltRewardUrn(self, position, rng)
         )
         return true
     end
-    totalChance = totalChance + 0.025
+    totalChance = totalChance + ROCK_ALT_CHANCES.Trinket
     if chance < totalChance then
         spawnTrinketWithSeed(nil, TrinketType.SWALLOWED_PENNY, position, rng)
         return true
     end
-    totalChance = totalChance + 0.005
+    totalChance = totalChance + ROCK_ALT_CHANCES.Collectible
     if chance < totalChance then
         local stillInPools = isCollectibleInItemPool(nil, CollectibleType.QUARTER, ItemPoolType.DEVIL)
         if stillInPools then
@@ -109,21 +113,21 @@ function spawnRockAltRewardMushroom(self, position, rng)
     local roomType = room:GetType()
     local chance = getRandom(nil, rng)
     local totalChance = 0
-    totalChance = totalChance + 0.68
+    totalChance = totalChance + ROCK_ALT_CHANCES.Nothing
     if chance < totalChance then
         return false
     end
-    totalChance = totalChance + 0.0982
+    totalChance = totalChance + ROCK_ALT_CHANCES.BasicDrop
     if chance < totalChance then
         spawnPillWithSeed(nil, PillColor.NULL, position, rng)
         return true
     end
-    totalChance = totalChance + 0.025
+    totalChance = totalChance + ROCK_ALT_CHANCES.Trinket
     if chance < totalChance then
         spawnTrinketWithSeed(nil, TrinketType.LIBERTY_CAP, position, rng)
         return true
     end
-    totalChance = totalChance + 0.005
+    totalChance = totalChance + ROCK_ALT_CHANCES.Collectible
     if chance < totalChance then
         if roomType == RoomType.SECRET then
             local wavyCapChance = getRandom(nil, rng)
@@ -165,21 +169,21 @@ end
 function spawnRockAltRewardSkull(self, position, rng)
     local chance = getRandom(nil, rng)
     local totalChance = 0
-    totalChance = totalChance + 0.68
+    totalChance = totalChance + ROCK_ALT_CHANCES.Nothing
     if chance < totalChance then
         return false
     end
-    totalChance = totalChance + 0.095
+    totalChance = totalChance + ROCK_ALT_CHANCES.BasicDrop
     if chance < totalChance then
         spawnCardWithSeed(nil, Card.NULL, position, rng)
         return true
     end
-    totalChance = totalChance + 0.025
+    totalChance = totalChance + ROCK_ALT_CHANCES.Trinket
     if chance < totalChance then
         spawnHeartWithSeed(nil, HeartSubType.BLACK, position, rng)
         return true
     end
-    totalChance = totalChance + 0.005
+    totalChance = totalChance + ROCK_ALT_CHANCES.Collectible
     if chance < totalChance then
         local ghostBabyStillInPools = isCollectibleInItemPool(nil, CollectibleType.GHOST_BABY, ItemPoolType.TREASURE)
         local dryBabyStillInPools = isCollectibleInItemPool(nil, CollectibleType.DRY_BABY, ItemPoolType.TREASURE)
@@ -209,29 +213,98 @@ function spawnRockAltRewardSkull(self, position, rng)
     )
     return true
 end
-function spawnRockAltRewardPolyp(self, _position, rng)
+function spawnRockAltRewardPolyp(self, position, rng)
     local chance = getRandom(nil, rng)
     local totalChance = 0
-    totalChance = totalChance + 0.68
+    totalChance = totalChance + ROCK_ALT_CHANCES.Nothing
     if chance < totalChance then
         return false
     end
-    return false
+    totalChance = totalChance + ROCK_ALT_CHANCES.BasicDrop
+    if chance < totalChance then
+        spawnHeartWithSeed(nil, HeartSubType.NULL, position, rng)
+        return true
+    end
+    totalChance = totalChance + ROCK_ALT_CHANCES.Trinket
+    if chance < totalChance then
+        spawnTrinketWithSeed(nil, TrinketType.UMBILICAL_CORD, position, rng)
+        return true
+    end
+    totalChance = totalChance + ROCK_ALT_CHANCES.Collectible
+    if chance < totalChance then
+        local placentaStillInPools = isCollectibleInItemPool(nil, CollectibleType.PLACENTA, ItemPoolType.BOSS)
+        local bloodClotStillInPools = isCollectibleInItemPool(nil, CollectibleType.BLOOD_CLOT, ItemPoolType.BOSS)
+        if bloodClotStillInPools and placentaStillInPools then
+            local collectibleChance = getRandom(nil, rng)
+            local collectibleType = collectibleChance < 0.5 and CollectibleType.PLACENTA or CollectibleType.BLOOD_CLOT
+            spawnCollectible(nil, collectibleType, position, rng)
+            return true
+        end
+        if bloodClotStillInPools then
+            spawnCollectible(nil, CollectibleType.MINI_MUSH, position, rng)
+            return true
+        end
+        if placentaStillInPools then
+            spawnCollectible(nil, CollectibleType.MAGIC_MUSHROOM, position, rng)
+            return true
+        end
+        return false
+    end
+    spawnEffectWithSeed(
+        nil,
+        EffectVariant.CREEP_RED,
+        0,
+        position,
+        rng
+    )
+    fireProjectilesInCircle(
+        nil,
+        nil,
+        position,
+        POLYP_PROJECTILE_SPEED,
+        POLYP_NUM_PROJECTILES
+    )
+    return true
 end
-function spawnRockAltRewardBucket(self, _position, rng)
+function spawnRockAltRewardBucket(self, _position, rng, _variant)
     local chance = getRandom(nil, rng)
     local totalChance = 0
-    totalChance = totalChance + 0.68
+    totalChance = totalChance + ROCK_ALT_CHANCES.Nothing
     if chance < totalChance then
         return false
     end
     return false
 end
+ROCK_ALT_CHANCES = {Nothing = 0.68, BasicDrop = 0.0967, Trinket = 0.025, Collectible = 0.005}
+POLYP_PROJECTILE_SPEED = 10
+POLYP_NUM_PROJECTILES = 6
+--- 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.
+function ____exports.getRockAltType(self)
+    local room = game:GetRoom()
+    local backdropType = room:GetBackdropType()
+    return BACKDROP_TYPE_TO_ROCK_ALT_TYPE[backdropType]
+end
 --- Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
 -- breaks.
 -- 
--- Note that 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.
+-- 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
@@ -239,45 +312,52 @@ end
 -- @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.
-function ____exports.spawnRockAltReward(self, position, rockAltType, seedOrRNG)
+function ____exports.spawnRockAltReward(self, position, rockAltType, variant, seedOrRNG)
+    if variant == nil then
+        variant = 0
+    end
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
     local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     repeat
-        local ____switch3 = rockAltType
-        local ____cond3 = ____switch3 == RockAltType.URN
-        if ____cond3 then
+        local ____switch4 = rockAltType
+        local ____cond4 = ____switch4 == RockAltType.URN
+        if ____cond4 then
             do
                 return spawnRockAltRewardUrn(nil, position, rng)
             end
         end
-        ____cond3 = ____cond3 or ____switch3 == RockAltType.MUSHROOM
-        if ____cond3 then
+        ____cond4 = ____cond4 or ____switch4 == RockAltType.MUSHROOM
+        if ____cond4 then
             do
                 return spawnRockAltRewardMushroom(nil, position, rng)
             end
         end
-        ____cond3 = ____cond3 or ____switch3 == RockAltType.SKULL
-        if ____cond3 then
+        ____cond4 = ____cond4 or ____switch4 == RockAltType.SKULL
+        if ____cond4 then
             do
                 return spawnRockAltRewardSkull(nil, position, rng)
             end
         end
-        ____cond3 = ____cond3 or ____switch3 == RockAltType.POLYP
-        if ____cond3 then
+        ____cond4 = ____cond4 or ____switch4 == RockAltType.POLYP
+        if ____cond4 then
             do
                 return spawnRockAltRewardPolyp(nil, position, rng)
             end
         end
-        ____cond3 = ____cond3 or ____switch3 == RockAltType.BUCKET
-        if ____cond3 then
+        ____cond4 = ____cond4 or ____switch4 == RockAltType.BUCKET
+        if ____cond4 then
             do
-                return spawnRockAltRewardBucket(nil, position, rng)
+                return spawnRockAltRewardBucket(nil, position, rng, variant)
             end
         end
     until true

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

@@ -1 +1 @@
-{"version":3,"file":"saveFile.d.ts","sourceRoot":"","sources":["../../src/functions/saveFile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAG7E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,eAAe,EAAE,eAAe,EAChC,YAAY,EAAE,YAAY,GACzB,OAAO,CAMT"}
+{"version":3,"file":"saveFile.d.ts","sourceRoot":"","sources":["../../src/functions/saveFile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAI7E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,eAAe,EAAE,eAAe,EAChC,YAAY,EAAE,YAAY,GACzB,OAAO,CAMT"}

package/dist/functions/saveFile.lua

@@ -1,4 +1,6 @@
 local ____exports = {}
+local ____itemPool = require("functions.itemPool")
+local isCollectibleInItemPool = ____itemPool.isCollectibleInItemPool
 local ____players = require("functions.players")
 local anyPlayerHasCollectible = ____players.anyPlayerHasCollectible
 --- Helper function to see if the given collectible is unlocked on the current save file. This
@@ -17,6 +19,6 @@ function ____exports.isCollectibleUnlocked(self, collectibleType, itemPoolType)
     if anyPlayerHasCollectible(nil, collectibleType) then
         return true
     end
-    return ____exports.isCollectibleUnlocked(nil, collectibleType, itemPoolType)
+    return isCollectibleInItemPool(nil, collectibleType, itemPoolType)
 end
 return ____exports

package/dist/functions/serialization.d.ts

@@ -1,12 +1,31 @@
-import { SerializationType } from "../enums/SerializationType";
-import { SerializedIsaacAPIClass } from "../types/private/SerializedIsaacAPIClass";
-export declare function copyIsaacAPIClass(isaacAPIClass: unknown, serializationType: SerializationType): unknown;
+import { SerializedIsaacAPIClass } from "../types/SerializedIsaacAPIClass";
 /**
- * Deserialization is a special case, so we make a dedicated function for this.
+ * Helper function to generically copy an Isaac API class without knowing what specific type of
+ * class it is. (This is used by the save data manager.)
  *
- * There is no need for a corresponding "serializeIsaacAPIClass" function because the
- * "copyIsaacAPIClass" function can handle all serialization types.
+ * For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+ */
+export declare function copyIsaacAPIClass(isaacAPIClass: unknown): unknown;
+/**
+ * Helper function to generically deserialize an Isaac API class without knowing what specific type
+ * of class it is. (This is used by the save data manager when reading data from the "save#.dat"
+ * file.)
+ *
+ * For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+ */
+export declare function deserializeIsaacAPIClass(serializedIsaacAPIClass: unknown): unknown;
+/**
+ * Helper function to generically check if a given Lua table is a serialized Isaac API class. (This
+ * is used by the save data manager when reading data from the "save#.dat" file.)
+ *
+ * For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
  */
-export declare function deserializeIsaacAPIClass(serializedIsaacAPIClass: SerializedIsaacAPIClass): unknown;
 export declare function isSerializedIsaacAPIClass(object: unknown): object is SerializedIsaacAPIClass;
+/**
+ * Helper function to generically serialize an Isaac API class without knowing what specific type of
+ * class it is. (This is used by the save data manager when writing data to the "save#.dat" file.)
+ *
+ * For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+ */
+export declare function serializeIsaacAPIClass(isaacAPIClass: unknown): unknown;
 //# sourceMappingURL=serialization.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"serialization.d.ts","sourceRoot":"","sources":["../../src/functions/serialization.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAI/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AAInF,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,OAAO,EACtB,iBAAiB,EAAE,iBAAiB,GACnC,OAAO,CA0BT;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,uBAAuB,EAAE,uBAAuB,GAC/C,OAAO,CAmBT;AAgBD,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,uBAAuB,CAKnC"}
+{"version":3,"file":"serialization.d.ts","sourceRoot":"","sources":["../../src/functions/serialization.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAI3E;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,OAAO,GAAG,OAAO,CA0BjE;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,uBAAuB,EAAE,OAAO,GAC/B,OAAO,CA0BT;AAoBD;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,uBAAuB,CAQnC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,OAAO,GAAG,OAAO,CA0BtE"}

package/dist/functions/serialization.lua

@@ -2,17 +2,14 @@ local ____lualib = require("lualib_bundle")
 local __TS__TypeOf = ____lualib.__TS__TypeOf
 local __TS__ObjectEntries = ____lualib.__TS__ObjectEntries
 local __TS__ObjectValues = ____lualib.__TS__ObjectValues
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArraySome = ____lualib.__TS__ArraySome
 local ____exports = {}
 local getSerializedTableType
-local ____SerializationType = require("enums.SerializationType")
-local SerializationType = ____SerializationType.SerializationType
 local ____isaacAPIClassTypeToBrand = require("objects.isaacAPIClassTypeToBrand")
 local ISAAC_API_CLASS_TYPE_TO_BRAND = ____isaacAPIClassTypeToBrand.ISAAC_API_CLASS_TYPE_TO_BRAND
-local ____isaacAPIClassTypeToCopyFunction = require("objects.isaacAPIClassTypeToCopyFunction")
-local ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION = ____isaacAPIClassTypeToCopyFunction.ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION
-local ____serializedIsaacAPIClassTypeToIdentityFunction = require("objects.serializedIsaacAPIClassTypeToIdentityFunction")
-local SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION = ____serializedIsaacAPIClassTypeToIdentityFunction.SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION
+local ____isaacAPIClassTypeToFunctions = require("objects.isaacAPIClassTypeToFunctions")
+local ISAAC_API_CLASS_TYPE_TO_FUNCTIONS = ____isaacAPIClassTypeToFunctions.ISAAC_API_CLASS_TYPE_TO_FUNCTIONS
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
 local ____types = require("functions.types")
@@ -28,7 +25,11 @@ function getSerializedTableType(self, serializedIsaacAPIClass)
     end
     return nil
 end
-function ____exports.copyIsaacAPIClass(self, isaacAPIClass, serializationType)
+--- Helper function to generically copy an Isaac API class without knowing what specific type of
+-- class it is. (This is used by the save data manager.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+function ____exports.copyIsaacAPIClass(self, isaacAPIClass)
     if not isUserdata(nil, isaacAPIClass) then
         error("Failed to copy an Isaac API class since the provided object was of type: " .. __TS__TypeOf(isaacAPIClass))
     end
@@ -37,32 +38,63 @@ function ____exports.copyIsaacAPIClass(self, isaacAPIClass, serializationType)
         error("Failed to copy an Isaac API class since it does not have a class type.")
     end
     local copyableIsaacAPIClassType = isaacAPIClassType
-    local copyFunction = ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION[copyableIsaacAPIClassType]
-    if copyFunction == nil then
-        error(("Failed to copy Isaac API class \"" .. copyableIsaacAPIClassType) .. "\" since there is not a defined copy function for this class type.")
+    local functions = ISAAC_API_CLASS_TYPE_TO_FUNCTIONS[copyableIsaacAPIClassType]
+    if functions == nil then
+        error("Failed to copy an Isaac API class since the associated functions were not found for Isaac API class type: " .. copyableIsaacAPIClassType)
     end
-    return copyFunction(nil, isaacAPIClass, serializationType)
+    return functions:copy(isaacAPIClass)
 end
---- Deserialization is a special case, so we make a dedicated function for this.
+--- Helper function to generically deserialize an Isaac API class without knowing what specific type
+-- of class it is. (This is used by the save data manager when reading data from the "save#.dat"
+-- file.)
 -- 
--- There is no need for a corresponding "serializeIsaacAPIClass" function because the
--- "copyIsaacAPIClass" function can handle all serialization types.
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
 function ____exports.deserializeIsaacAPIClass(self, serializedIsaacAPIClass)
     if not isTable(nil, serializedIsaacAPIClass) then
         error("Failed to deserialize an Isaac API class since the provided object was of type: " .. __TS__TypeOf(serializedIsaacAPIClass))
     end
     local copyableIsaacAPIClassType = getSerializedTableType(nil, serializedIsaacAPIClass)
     if copyableIsaacAPIClassType == nil then
-        error("Failed to deserialize an API class since a valid class type brand was not found.")
+        error("Failed to deserialize an Isaac API class since a valid class type brand was not found.")
+    end
+    local functions = ISAAC_API_CLASS_TYPE_TO_FUNCTIONS[copyableIsaacAPIClassType]
+    if functions == nil then
+        error("Failed to deserialize an Isaac API class since the associated functions were not found for class type: " .. copyableIsaacAPIClassType)
     end
-    local copyFunction = ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION[copyableIsaacAPIClassType]
-    return copyFunction(nil, serializedIsaacAPIClass, SerializationType.DESERIALIZE)
+    return functions:deserialize(serializedIsaacAPIClass)
 end
+--- Helper function to generically check if a given Lua table is a serialized Isaac API class. (This
+-- is used by the save data manager when reading data from the "save#.dat" file.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
 function ____exports.isSerializedIsaacAPIClass(self, object)
-    local identityFunctions = __TS__ObjectValues(SERIALIZED_ISAAC_API_CLASS_TYPE_TO_IDENTITY_FUNCTION)
+    local allFunctions = __TS__ObjectValues(ISAAC_API_CLASS_TYPE_TO_FUNCTIONS)
+    local isSerializedFunctions = __TS__ArrayMap(
+        allFunctions,
+        function(____, functions) return functions.isSerialized end
+    )
     return __TS__ArraySome(
-        identityFunctions,
+        isSerializedFunctions,
         function(____, identityFunction) return identityFunction(nil, object) end
     )
 end
+--- Helper function to generically serialize an Isaac API class without knowing what specific type of
+-- class it is. (This is used by the save data manager when writing data to the "save#.dat" file.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+function ____exports.serializeIsaacAPIClass(self, isaacAPIClass)
+    if not isUserdata(nil, isaacAPIClass) then
+        error("Failed to serialize an Isaac API class since the provided object was of type: " .. __TS__TypeOf(isaacAPIClass))
+    end
+    local isaacAPIClassType = getIsaacAPIClassName(nil, isaacAPIClass)
+    if isaacAPIClassType == nil then
+        error("Failed to serialize an Isaac API class since it does not have a class type.")
+    end
+    local copyableIsaacAPIClassType = isaacAPIClassType
+    local functions = ISAAC_API_CLASS_TYPE_TO_FUNCTIONS[copyableIsaacAPIClassType]
+    if functions == nil then
+        error("Failed to serialize an Isaac API class since the associated functions were not found for class type: " .. copyableIsaacAPIClassType)
+    end
+    return functions:serialize(isaacAPIClass)
+end
 return ____exports

package/dist/functions/table.d.ts

@@ -14,8 +14,8 @@ export declare function copyValuesToTable(object: unknown, keys: string[], luaMa
  */
 export declare function getBooleansFromTable(luaMap: LuaMap<string, unknown>, objectName: string, ...keys: string[]): boolean[];
 /**
- * Helper function to safely get number values from a Lua table. Will throw an error if the specific
- * value does not exist on the table or if it cannot be converted to a number.
+ * Helper function to safely get number values from specific keys on a Lua table. Will throw an
+ * error if the specific value does not exist on the table or if it cannot be converted to a number.
  *
  * This function is variadic, meaning that you can specify N arguments to get N values.
  */

package/dist/functions/table.lua

@@ -43,8 +43,8 @@ function ____exports.getBooleansFromTable(self, luaMap, objectName, ...)
     end
     return booleans
 end
---- Helper function to safely get number values from a Lua table. Will throw an error if the specific
--- value does not exist on the table or if it cannot be converted to a number.
+--- Helper function to safely get number values from specific keys on a Lua table. Will throw an
+-- error if the specific value does not exist on the table or if it cannot be converted to a number.
 -- 
 -- This function is variadic, meaning that you can specify N arguments to get N values.
 function ____exports.getNumbersFromTable(self, luaMap, objectName, ...)

package/dist/functions/tstlClass.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { DefaultMap } from "../classes/DefaultMap";
-import { TSTLClass } from "../types/private/TSTLClass";
+import { TSTLClass } from "../types/TSTLClass";
 /**
  * Helper function to get the name of a TypeScriptToLua class. TSTL classes are Lua tables created
  * with the `__TS__Class` Lua function from the TSTL lualib. Their name is contained within