isaacscript-common 3.16.0 → 4.0.0

package/callbacks/subscriptions/postPlayerCollectibleAdded.d.ts

@@ -1,6 +1,5 @@
-import { CollectibleType, PlayerType, PlayerVariant } from "isaac-typescript-definitions";
+import { CollectibleType } from "isaac-typescript-definitions";
 export declare type PostPlayerCollectibleAddedRegisterParameters = [
     callback: (player: EntityPlayer, collectibleType: CollectibleType) => void,
-    playerVariant?: PlayerVariant,
-    character?: PlayerType
+    collectibleType?: CollectibleType
 ];

package/callbacks/subscriptions/postPlayerCollectibleAdded.lua

@@ -14,16 +14,11 @@ end
 ---
 -- @internal
 function ____exports.postPlayerCollectibleAddedFire(self, player, collectibleType)
-    local character = player:GetPlayerType()
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]
-        local playerVariant = ____value[2]
-        local callbackCharacter = ____value[3]
+        local callbackCollectibleType = ____value[2]
         do
-            if playerVariant ~= nil and playerVariant ~= player.Variant then
-                goto __continue5
-            end
-            if callbackCharacter ~= nil and callbackCharacter ~= character then
+            if callbackCollectibleType ~= nil and callbackCollectibleType ~= collectibleType then
                 goto __continue5
             end
             callback(nil, player, collectibleType)

package/callbacks/subscriptions/postPlayerCollectibleRemoved.d.ts

@@ -1,6 +1,5 @@
-import { CollectibleType, PlayerType, PlayerVariant } from "isaac-typescript-definitions";
+import { CollectibleType } from "isaac-typescript-definitions";
 export declare type PostPlayerCollectibleRemovedRegisterParameters = [
     callback: (player: EntityPlayer, collectibleType: CollectibleType) => void,
-    playerVariant?: PlayerVariant,
-    character?: PlayerType
+    collectibleType?: CollectibleType
 ];

package/callbacks/subscriptions/postPlayerCollectibleRemoved.lua

@@ -14,16 +14,11 @@ end
 ---
 -- @internal
 function ____exports.postPlayerCollectibleRemovedFire(self, player, collectibleType)
-    local character = player:GetPlayerType()
     for ____, ____value in ipairs(subscriptions) do
         local callback = ____value[1]
-        local playerVariant = ____value[2]
-        local callbackCharacter = ____value[3]
+        local callbackCollectibleType = ____value[2]
         do
-            if playerVariant ~= nil and playerVariant ~= player.Variant then
-                goto __continue5
-            end
-            if callbackCharacter ~= nil and callbackCharacter ~= character then
+            if callbackCollectibleType ~= nil and callbackCollectibleType ~= collectibleType then
                 goto __continue5
             end
             callback(nil, player, collectibleType)

package/callbacks/subscriptions/preBerserkDeath.d.ts

@@ -1,6 +1,6 @@
 import { PlayerType, PlayerVariant } from "isaac-typescript-definitions";
 export declare type PreBerserkDeathRegisterParameters = [
-    callback: (player: EntityPlayer) => boolean | void,
+    callback: (player: EntityPlayer) => void,
     playerVariant?: PlayerVariant,
     character?: PlayerType
 ];

package/classes/ModUpgraded.d.ts

@@ -2,9 +2,9 @@ import { ModCallback } from "isaac-typescript-definitions";
 import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { AddCallbackParameterCustom } from "../interfaces/AddCallbackParameterCustom";
 /**
- * `isaacscript-common` has many {@link ModCallbackCustom custom callbacks} that you can use in your
- * mods. Instead of hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to
- * use, which extends the base class and adds a new method of `AddCallbackCustom`.
+ * `isaacscript-common` has many custom callbacks that you can use in your mods. Instead of
+ * hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to use, which
+ * extends the base class and adds a new method of `AddCallbackCustom`.
  *
  * To upgrade your mod, use the `upgradeMod` helper function.
  */

package/classes/ModUpgraded.lua

@@ -3,9 +3,9 @@ local __TS__Class = ____lualib.__TS__Class
 local ____exports = {}
 local ____callbackRegisterFunctions = require("objects.callbackRegisterFunctions")
 local CALLBACK_REGISTER_FUNCTIONS = ____callbackRegisterFunctions.CALLBACK_REGISTER_FUNCTIONS
---- `isaacscript-common` has many {@link ModCallbackCustomcustom callbacks} that you can use in your
--- mods. Instead of hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to
--- use, which extends the base class and adds a new method of `AddCallbackCustom`.
+--- `isaacscript-common` has many custom callbacks that you can use in your mods. Instead of
+-- hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to use, which
+-- extends the base class and adds a new method of `AddCallbackCustom`.
 -- 
 -- To upgrade your mod, use the `upgradeMod` helper function.
 ____exports.ModUpgraded = __TS__Class()
@@ -35,9 +35,6 @@ function ModUpgraded.prototype.SaveData(self, data)
 end
 function ModUpgraded.prototype.AddCallbackCustom(self, modCallbackCustom, ...)
     local callbackRegisterFunction = CALLBACK_REGISTER_FUNCTIONS[modCallbackCustom]
-    if callbackRegisterFunction == nil then
-        error("Failed to find a callback registration function for custom callback: " .. tostring(modCallbackCustom))
-    end
     callbackRegisterFunction(nil, ...)
 end
 return ____exports

package/constants.d.ts

@@ -15,7 +15,7 @@ export declare const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.
 /** Bombs explode when their frame count is equal to this value. */
 export declare const BOMB_EXPLODE_FRAME = 45;
 /** This is the initial value of the `EntityPickup.Wait` property after a collectible is spawned. */
-export declare const COLLECTIBLE_STARTING_WAIT = 20;
+export declare const COLLECTIBLE_INITIAL_WAIT = 20;
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
 /** This is also the distance that a player spawns from the door that they enter a room from. */
 export declare const DISTANCE_OF_GRID_TILE = 40;

package/constants.lua

@@ -19,7 +19,7 @@ ____exports.BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png"
 --- Bombs explode when their frame count is equal to this value.
 ____exports.BOMB_EXPLODE_FRAME = 45
 --- This is the initial value of the `EntityPickup.Wait` property after a collectible is spawned.
-____exports.COLLECTIBLE_STARTING_WAIT = 20
+____exports.COLLECTIBLE_INITIAL_WAIT = 20
 ____exports.DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE
 --- This is also the distance that a player spawns from the door that they enter a room from.
 ____exports.DISTANCE_OF_GRID_TILE = 40

package/enums/ModCallbackCustom.d.ts

@@ -121,7 +121,7 @@ export declare enum ModCallbackCustom {
      * only fire if the revival type matches the one provided.
      *
      * ```ts
-     * function postCustomRevive(player: EntityPlayer, revivalType: int) {}
+     * function postCustomRevive(player: EntityPlayer, revivalType: int): void {}
      * ```
      */
     POST_CUSTOM_REVIVE = 8,
@@ -133,7 +133,10 @@ export declare enum ModCallbackCustom {
      * only fire if the `DiceFloorSubType` type matches the one provided.
      *
      * ```ts
-     * function postDiceRoomActivated(player: EntityPlayer, diceFloorSubType: DiceFloorSubType) {}
+     * function postDiceRoomActivated(
+     *   player: EntityPlayer,
+     *   diceFloorSubType: DiceFloorSubType,
+     * ): void {}
      * ```
      */
     POST_DICE_ROOM_ACTIVATED = 9,
@@ -281,7 +284,7 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_UPDATE` callback when the Greed Mode wave increases.
      *
      * ```ts
-     * function postGreedModeWave(oldWave: int, newWave: int) {}
+     * function postGreedModeWave(oldWave: int, newWave: int): void {}
      * ```
      */
     POST_GREED_MODE_WAVE = 21,
@@ -676,7 +679,7 @@ export declare enum ModCallbackCustom {
      *   player: EntityPlayer,
      *   healthType: HealthType,
      *   difference: int,
-     * ) {}
+     * ): void {}
      * ```
      */
     POST_PLAYER_CHANGE_HEALTH = 46,
@@ -694,7 +697,7 @@ export declare enum ModCallbackCustom {
      *   player: EntityPlayer,
      *   oldCharacter: PlayerType,
      *   newCharacter: PlayerType,
-     * ) {}
+     * ): void {}
      * ```
      */
     POST_PLAYER_CHANGE_TYPE = 47,
@@ -702,13 +705,14 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is higher than
      * what it was on the previous frame.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if the player matches the `CollectibleType` provided.
      *
      * ```ts
-     * function postPlayerCollectibleAdded(player: EntityPlayer, collectibleType: CollectibleType) {}
+     * function postPlayerCollectibleAdded(
+     *   player: EntityPlayer,
+     *   collectibleType: CollectibleType,
+     * ): void {}
      * ```
      */
     POST_PLAYER_COLLECTIBLE_ADDED = 48,
@@ -716,16 +720,14 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is lower than
      * what it was on the previous frame.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if the player matches the `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleRemoved(
      *   player: EntityPlayer,
      *   collectibleType: CollectibleType,
-     * ) {}
+     * ): void {}
      * ```
      */
     POST_PLAYER_COLLECTIBLE_REMOVED = 49,
@@ -742,7 +744,7 @@ export declare enum ModCallbackCustom {
      *   only fire if the player matches the `PlayerType` provided.
      *
      * ```ts
-     * function postPlayerFatalDamage(player: EntityPlayer) {}
+     * function postPlayerFatalDamage(player: EntityPlayer): boolean | void {}
      * ```
      */
     POST_PLAYER_FATAL_DAMAGE = 50,
@@ -1128,7 +1130,7 @@ export declare enum ModCallbackCustom {
      *   only fire if the player matches the `PlayerType` provided.
      *
      * ```ts
-     * function preBerserkDeath(player: EntityPlayer) {}
+     * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
     PRE_BERSERK_DEATH = 78,
@@ -1146,7 +1148,7 @@ export declare enum ModCallbackCustom {
      *   only fire if the player matches the `PlayerType` provided.
      *
      * ```ts
-     * function preCustomRevive(player: EntityPlayer) {}
+     * function preCustomRevive(player: EntityPlayer): int | void {}
      * ```
      */
     PRE_CUSTOM_REVIVE = 79,

package/features/extraConsoleCommands/commandsSubroutines.lua

@@ -108,7 +108,7 @@ function ____exports.spawnTrapdoorOrCrawlspace(self, trapdoor)
 end
 function ____exports.warpToRoomType(self, roomType)
     local roomTypeName = ROOM_TYPE_NAMES[roomType]
-    if roomTypeName == nil or roomTypeName == DEFAULT_ROOM_TYPE_NAME then
+    if roomTypeName == DEFAULT_ROOM_TYPE_NAME then
         printConsole(
             nil,
             "Invalid room type: " .. tostring(roomType)

package/functions/cards.lua

@@ -117,7 +117,7 @@ end
 -- ```
 function ____exports.getCardName(self, card)
     local cardName = CARD_NAMES[card]
-    if cardName ~= nil and cardName ~= DEFAULT_CARD_NAME then
+    if cardName ~= nil then
         return cardName
     end
     local itemConfigCard = itemConfig:GetCard(card)

package/functions/color.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedColor = LuaTable<string, unknown> & {
-    __serializedColorBrand: void;
+    readonly __serializedColorBrand: unique symbol;
 };
 interface CopyColorReturn {
     [SerializationType.NONE]: Color;

package/functions/debug.lua

@@ -24,7 +24,7 @@ end
 -- This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
 -- is enabled or not.
 function ____exports.isLuaDebugEnabled(self)
-    return package ~= nil
+    return _G.package ~= nil
 end
 --- Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
 -- `console.trace` function.
@@ -36,7 +36,7 @@ function ____exports.traceback(self)
     log(tracebackOutput)
 end
 local function setDebugFunctionsGlobal(self)
-    if debug == nil and sandboxGetTraceback == nil then
+    if _G.debug == nil and sandboxGetTraceback == nil then
         return
     end
     local globals = _G

package/functions/doors.lua

@@ -144,8 +144,7 @@ function ____exports.getDoorEnterPosition(self, door)
 end
 --- Helper function to get the possible door slots that can exist for a given room shape.
 function ____exports.getDoorSlotsForRoomShape(self, roomShape)
-    local doorSlots = ROOM_SHAPE_TO_DOOR_SLOTS[roomShape]
-    return doorSlots == nil and __TS__New(Set) or doorSlots
+    return ROOM_SHAPE_TO_DOOR_SLOTS[roomShape]
 end
 --- Helper function to get all of the doors in the room that lead to the provided room index.
 -- 

package/functions/globals.d.ts

@@ -5,10 +5,10 @@
  *
  * Returns a slightly different set depending on whether the "--luadebug" flag is enabled or not.
  */
-export declare function getDefaultGlobals(): Set<string>;
+export declare function getDefaultGlobals(): ReadonlySet<string>;
 /**
  * Helper function to get an array of any added global variables in the Isaac Lua environment.
- * Returns an array of key/value tuples.
+ * Returns a sorted array of key/value tuples.
  */
-export declare function getNewGlobals(): Array<[AnyNotNil, unknown]>;
+export declare function getNewGlobals(): ReadonlyArray<[AnyNotNil, unknown]>;
 export declare function logNewGlobals(): void;

package/functions/globals.lua

@@ -4,6 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local ____exports = {}
+local isRacingPlusSandboxEnabled
 local ____debug = require("functions.debug")
 local isLuaDebugEnabled = ____debug.isLuaDebugEnabled
 local ____log = require("functions.log")
@@ -13,6 +14,9 @@ local addSetsToSet = ____set.addSetsToSet
 local copySet = ____set.copySet
 local ____utils = require("functions.utils")
 local twoDimensionalSort = ____utils.twoDimensionalSort
+function isRacingPlusSandboxEnabled(self)
+    return getParentFunctionDescription ~= nil
+end
 local DEFAULT_GLOBALS = __TS__New(Set, {
     "ActionTriggers",
     "ActiveSlot",
@@ -191,11 +195,13 @@ function ____exports.getDefaultGlobals(self)
     if isLuaDebugEnabled(nil) then
         addSetsToSet(nil, defaultGlobals, LUA_DEBUG_ADDED_GLOBALS)
     end
-    addSetsToSet(nil, defaultGlobals, RACING_PLUS_SANDBOX_ADDED_GLOBALS)
+    if isRacingPlusSandboxEnabled(nil) then
+        addSetsToSet(nil, defaultGlobals, RACING_PLUS_SANDBOX_ADDED_GLOBALS)
+    end
     return defaultGlobals
 end
 --- Helper function to get an array of any added global variables in the Isaac Lua environment.
--- Returns an array of key/value tuples.
+-- Returns a sorted array of key/value tuples.
 function ____exports.getNewGlobals(self)
     local defaultGlobals = ____exports.getDefaultGlobals(nil)
     local newGlobals = {}

package/functions/kColor.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedKColor = LuaTable<string, unknown> & {
-    __serializedKColorBrand: void;
+    readonly __serializedKColorBrand: unique symbol;
 };
 interface CopyKColorReturn {
     [SerializationType.NONE]: KColor;

package/functions/pills.lua

@@ -114,7 +114,7 @@ end
 -- ```
 function ____exports.getPillEffectName(self, pillEffect)
     local pillEffectName = PILL_EFFECT_NAMES[pillEffect]
-    if pillEffectName ~= nil and pillEffectName ~= DEFAULT_PILL_EFFECT_NAME then
+    if pillEffectName ~= nil then
         return pillEffectName
     end
     local itemConfigPillEffect = itemConfig:GetPillEffect(pillEffect)

package/functions/playerHealth.d.ts

@@ -12,6 +12,8 @@ export declare function addPlayerHealthType(player: EntityPlayer, healthType: He
  */
 export declare function getPlayerHealth(player: EntityPlayer): PlayerHealth;
 export declare function getPlayerHealthType(player: EntityPlayer, healthType: HealthType): int;
+/** Returns a `PlayerHealth` object with all 0s. */
+export declare function newPlayerHealth(): PlayerHealth;
 export declare function playerConvertBlackHeartsToSoulHearts(player: EntityPlayer): void;
 export declare function playerConvertSoulHeartsToBlackHearts(player: EntityPlayer): void;
 export declare function removeAllPlayerHealth(player: EntityPlayer): void;

package/functions/playerHealth.lua

@@ -3,17 +3,24 @@ local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local HeartSubType = ____isaac_2Dtypescript_2Ddefinitions.HeartSubType
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
 local ____constants = require("constants")
 local MAX_PLAYER_HEART_CONTAINERS = ____constants.MAX_PLAYER_HEART_CONTAINERS
 local ____HealthType = require("enums.HealthType")
 local HealthType = ____HealthType.HealthType
+local ____charge = require("functions.charge")
+local getTotalCharge = ____charge.getTotalCharge
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
 local ____player = require("functions.player")
 local getPlayerBlackHearts = ____player.getPlayerBlackHearts
 local getPlayerHearts = ____player.getPlayerHearts
 local getPlayerSoulHearts = ____player.getPlayerSoulHearts
 local isCharacter = ____player.isCharacter
+local setActiveItem = ____player.setActiveItem
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
 local ____repeat = ____utils["repeat"]
@@ -45,6 +52,17 @@ function ____exports.setPlayerHealth(self, player, playerHealth)
     local character = player:GetPlayerType()
     local subPlayer = player:GetSubPlayer()
     ____exports.removeAllPlayerHealth(nil, player)
+    local alabasterBoxes = {}
+    if player:HasCollectible(CollectibleType.ALABASTER_BOX) then
+        for ____, activeSlot in ipairs(getEnumValues(nil, ActiveSlot)) do
+            local activeItem = player:GetActiveItem()
+            if activeItem == CollectibleType.ALABASTER_BOX then
+                local totalCharge = getTotalCharge(nil, player, activeSlot)
+                setActiveItem(nil, player, CollectibleType.NULL, activeSlot)
+                alabasterBoxes[#alabasterBoxes + 1] = {activeSlot, totalCharge}
+            end
+        end
+    end
     if character == PlayerType.THE_SOUL and subPlayer ~= nil then
         subPlayer:AddMaxHearts(playerHealth.maxHearts, false)
     else
@@ -89,6 +107,17 @@ function ____exports.setPlayerHealth(self, player, playerHealth)
     elseif character == PlayerType.BETHANY_B then
         player:SetBloodCharge(playerHealth.bloodCharges)
     end
+    for ____, ____value in ipairs(alabasterBoxes) do
+        local activeSlot = ____value[1]
+        local totalCharge = ____value[2]
+        setActiveItem(
+            nil,
+            player,
+            CollectibleType.ALABASTER_BOX,
+            activeSlot,
+            totalCharge
+        )
+    end
 end
 function ____exports.addPlayerHealthType(self, player, healthType, numHearts)
     repeat
@@ -294,6 +323,22 @@ function ____exports.getPlayerHealthType(self, player, healthType)
         end
     until true
 end
+--- Returns a `PlayerHealth` object with all 0s.
+function ____exports.newPlayerHealth(self)
+    return {
+        maxHearts = 0,
+        hearts = 0,
+        eternalHearts = 0,
+        soulHearts = 0,
+        boneHearts = 0,
+        goldenHearts = 0,
+        rottenHearts = 0,
+        brokenHearts = 0,
+        soulCharges = 0,
+        bloodCharges = 0,
+        soulHeartTypes = {}
+    }
+end
 function ____exports.playerConvertBlackHeartsToSoulHearts(self, player)
     local playerHealth = ____exports.getPlayerHealth(nil, player)
     ____exports.removeAllPlayerHealth(nil, player)

package/functions/rng.d.ts

@@ -3,7 +3,7 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedRNG = LuaTable<string, unknown> & {
-    __serializedRNGBrand: void;
+    readonly __serializedRNGBrand: unique symbol;
 };
 interface CopyRNGReturn {
     [SerializationType.NONE]: RNG;

package/functions/rooms.lua

@@ -32,7 +32,6 @@ local NUM_DIMENSIONS = ____constants.NUM_DIMENSIONS
 local ____roomShapeToDoorSlotsToGridIndexDelta = require("objects.roomShapeToDoorSlotsToGridIndexDelta")
 local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToDoorSlotsToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
 local ____roomTypeNames = require("objects.roomTypeNames")
-local DEFAULT_ROOM_TYPE_NAME = ____roomTypeNames.DEFAULT_ROOM_TYPE_NAME
 local ROOM_TYPE_NAMES = ____roomTypeNames.ROOM_TYPE_NAMES
 local ____mineShaftRoomSubTypesSet = require("sets.mineShaftRoomSubTypesSet")
 local MINE_SHAFT_ROOM_SUB_TYPE_SET = ____mineShaftRoomSubTypesSet.MINE_SHAFT_ROOM_SUB_TYPE_SET
@@ -208,8 +207,7 @@ end
 -- 
 -- For example, `RoomType.TREASURE` will return "Treasure Room".
 function ____exports.getRoomTypeName(self, roomType)
-    local roomTypeName = ROOM_TYPE_NAMES[roomType]
-    return roomTypeName == nil and DEFAULT_ROOM_TYPE_NAME or roomTypeName
+    return ROOM_TYPE_NAMES[roomType]
 end
 --- Helper function to get the room descriptor for every room on the level in a specific dimension.
 -- Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be

package/functions/serialization.lua

@@ -56,9 +56,6 @@ function ____exports.deserializeIsaacAPIClass(self, serializedIsaacAPIClass)
         error("Failed to deserialize an API class since a valid class type brand was not found.")
     end
     local copyFunction = ISAAC_API_CLASS_TYPE_TO_COPY_FUNCTION[copyableIsaacAPIClassType]
-    if copyFunction == nil then
-        error(("Failed to deserialize Isaac API class \"" .. copyableIsaacAPIClassType) .. "\" since there is not a defined copy function for this class type.")
-    end
     return copyFunction(nil, serializedIsaacAPIClass, SerializationType.DESERIALIZE)
 end
 function ____exports.isSerializedIsaacAPIClass(self, object)

package/functions/transformations.lua

@@ -9,7 +9,6 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
 local PlayerForm = ____isaac_2Dtypescript_2Ddefinitions.PlayerForm
 local ____transformationNames = require("objects.transformationNames")
-local DEFAULT_TRANSFORMATION_NAME = ____transformationNames.DEFAULT_TRANSFORMATION_NAME
 local TRANSFORMATION_NAMES = ____transformationNames.TRANSFORMATION_NAMES
 local ____collectibles = require("functions.collectibles")
 local getCollectibleTags = ____collectibles.getCollectibleTags
@@ -79,8 +78,7 @@ end
 -- // transformationName is "Beelzebub"
 -- ```
 function ____exports.getTransformationName(self, playerForm)
-    local transformationName = TRANSFORMATION_NAMES[playerForm]
-    return transformationName == nil and DEFAULT_TRANSFORMATION_NAME or transformationName
+    return TRANSFORMATION_NAMES[playerForm]
 end
 function ____exports.getTransformationsForCollectibleType(self, collectibleType)
     local itemConfigTags = getCollectibleTags(nil, collectibleType)

package/functions/vector.d.ts

@@ -2,7 +2,7 @@
 import { Direction } from "isaac-typescript-definitions";
 import { SerializationType } from "../enums/SerializationType";
 declare type SerializedVector = LuaTable<string, unknown> & {
-    __serializedVectorBrand: void;
+    readonly __serializedVectorBrand: unique symbol;
 };
 interface CopyVectorReturn {
     [SerializationType.NONE]: Vector;

package/interfaces/JSONDoor.d.ts

@@ -1,4 +1,4 @@
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONDoor {
     $: {
         /** Equal to "True" or "False". */

package/interfaces/JSONEntity.d.ts

@@ -1,4 +1,4 @@
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONEntity {
     $: {
         /** Needs to be converted to an int. */

package/interfaces/JSONRoom.d.ts

@@ -1,6 +1,6 @@
 import { JSONDoor } from "./JSONDoor";
 import { JSONSpawn } from "./JSONSpawn";
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONRoom {
     $: {
         /** Needs to be converted to an int. */

package/interfaces/JSONSpawn.d.ts

@@ -1,5 +1,5 @@
 import { JSONEntity } from "./JSONEntity";
-/** Part of {@link JSONRooms}. */
+/** Part of `JSONRooms`. */
 export interface JSONSpawn {
     $: {
         /** Needs to be converted to an int. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "3.16.0",
+  "version": "4.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^2.2.3"
+    "isaac-typescript-definitions": "^3.0.3"
   }
 }

package/types/CollectibleIndex.d.ts

@@ -12,5 +12,5 @@
  * This type is branded for extra type safety.
  */
 export declare type CollectibleIndex = string & {
-    __collectibleIndexBrand: void;
+    readonly __collectibleIndexBrand: unique symbol;
 };

package/types/PickingUpItem.d.ts

@@ -5,21 +5,21 @@
  */
 import { CollectibleType, ItemType, TrinketType } from "isaac-typescript-definitions";
 export declare type PickingUpItem = PickingUpItemNull | PickingUpItemCollectible | PickingUpItemTrinket;
-/** Part of {@link PickingUpItem}. */
+/** Part of `PickingUpItem`. */
 export interface PickingUpItemNull {
     /** Needed so that we can distinguish between picking up a collectible and a trinket. */
     itemType: ItemType.NULL;
     /** Equal to either the collectible type, the trinket type, or 0. */
     subType: 0;
 }
-/** Part of {@link PickingUpItem}. */
+/** Part of `PickingUpItem`. */
 export interface PickingUpItemCollectible {
     /** Needed so that we can distinguish between picking up a collectible and a trinket. */
     itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR;
     /** Equal to either the collectible type, the trinket type, or 0. */
     subType: CollectibleType;
 }
-/** Part of {@link PickingUpItem}. */
+/** Part of `PickingUpItem`. */
 export interface PickingUpItemTrinket {
     /** Needed so that we can distinguish between picking up a collectible and a trinket. */
     itemType: ItemType.TRINKET;

package/types/PlayerIndex.d.ts

@@ -12,5 +12,5 @@
  * This type is branded for extra type safety.
  */
 export declare type PlayerIndex = int & {
-    __playerIndexBrand: void;
+    readonly __playerIndexBrand: unique symbol;
 };

package/types/private/IsaacAPIClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type IsaacAPIClass = LuaTable<string, unknown> & {
-    __isaacAPIClassBrand: void;
+    readonly __isaacAPIClassBrand: unique symbol;
 };

package/types/private/SerializedIsaacAPIClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type SerializedIsaacAPIClass = LuaTable<string, unknown> & {
-    __serializedIsaacAPIClassBrand: void;
+    readonly __serializedIsaacAPIClassBrand: unique symbol;
 };

package/types/private/TSTLClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type TSTLClass = LuaTable<AnyNotNil, unknown> & {
-    __tstlClassBrand: void;
+    readonly __tstlClassBrand: unique symbol;
 };

package/upgradeMod.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="isaac-typescript-definitions" />
 import { ModUpgraded } from "./classes/ModUpgraded";
 /**
- * Use this function to enable the {@link ModCallbackCustom custom callbacks} and other optional
- * features provided by `isaacscript-common`.
+ * Use this function to enable the custom callbacks and other optional features provided by
+ * `isaacscript-common`.
  *
  * For example:
  *

package/upgradeMod.lua

@@ -17,8 +17,8 @@ local initFeaturesMajor = ____initFeatures.initFeaturesMajor
 local initFeaturesMinor = ____initFeatures.initFeaturesMinor
 local ____patchErrorFunctions = require("patchErrorFunctions")
 local patchErrorFunction = ____patchErrorFunctions.patchErrorFunction
---- Use this function to enable the {@link ModCallbackCustomcustom callbacks} and other optional
--- features provided by `isaacscript-common`.
+--- Use this function to enable the custom callbacks and other optional features provided by
+-- `isaacscript-common`.
 -- 
 -- For example:
 --