isaacscript-common 1.2.159 → 1.2.162

package/dist/callbacks/customRevive.lua

@@ -3,6 +3,8 @@ local ____exports = {}
 local hasSubscriptions, postRender, postNewRoom, postPEffectUpdateReordered, checkWaitingForItemAnimation, postPlayerFatalDamage, preBerserkDeath, playerIsAboutToDie, logStateChanged, DEBUG, CustomReviveState, v
 local ____cachedClasses = require("cachedClasses")
 local sfxManager = ____cachedClasses.sfxManager
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____runInNFrames = require("features.runInNFrames")
 local runNextGameFrame = ____runInNFrames.runNextGameFrame
 local ____exports = require("features.saveDataManager.exports")
@@ -16,8 +18,6 @@ local log = ____log.log
 local ____player = require("functions.player")
 local getPlayerFromIndex = ____player.getPlayerFromIndex
 local getPlayerIndex = ____player.getPlayerIndex
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____postCustomRevive = require("callbacks.subscriptions.postCustomRevive")
 local postCustomReviveFire = ____postCustomRevive.postCustomReviveFire
 local postCustomReviveHasSubscriptions = ____postCustomRevive.postCustomReviveHasSubscriptions

package/dist/callbacks/itemPickup.lua

@@ -3,14 +3,14 @@ local ____lualib = require("lualib_bundle")
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local hasSubscriptions, postPEffectUpdateReordered, queueEmpty, queueNotEmpty, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____playerDataStructures = require("functions.playerDataStructures")
 local defaultMapGetPlayer = ____playerDataStructures.defaultMapGetPlayer
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____PickingUpItem = require("types.PickingUpItem")
 local newPickingUpItem = ____PickingUpItem.newPickingUpItem
 local resetPickingUpItem = ____PickingUpItem.resetPickingUpItem

package/dist/callbacks/postCustomDoorEnter.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+import { ModUpgraded } from "../classes/ModUpgraded";
 /**
  * `isaacscript-common` provides custom doors that can be spawned where any wall segment is. If you
  * use this feature, you must first call this initialization function at the beginning of your mod.
@@ -22,7 +23,7 @@
  * initCustomDoor(mod, fooEffectVariant);
  * ```
  */
-export declare function initCustomDoor(mod: Mod, effectVariant: int): void;
+export declare function initCustomDoor(mod: ModUpgraded, effectVariant: int): void;
 /**
  * Helper function to spawn a custom door. This is intended to be called from the `MC_POST_NEW_ROOM`
  * callback when the player enters a room that should have a custom door. (You could also call it

package/dist/callbacks/postCustomDoorEnter.lua

@@ -4,13 +4,17 @@ local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local Map = ____lualib.Map
 local ____exports = {}
-local hasSubscriptions, postEffectUpdaterCustomEntity, doorChangedState, getAnimationForCustomDoor, postEffectRenderCustomEntity, isPlayerPastDoorThreshold, getPositionOffset, POSITION_OFFSET_MULTIPLIER, v
+local hasSubscriptions, postEffectUpdaterCustomEntity, doorChangedState, getAnimationForCustomDoor, postEffectRenderCustomEntity, isPlayerPastDoorThreshold, roomClearChange, getPositionOffset, POSITION_OFFSET_MULTIPLIER, v
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____doors = require("functions.doors")
 local doorSlotToDirection = ____doors.doorSlotToDirection
+local ____entitySpecific = require("functions.entitySpecific")
+local getEffects = ____entitySpecific.getEffects
 local ____player = require("functions.player")
 local getClosestPlayer = ____player.getClosestPlayer
 local ____utils = require("functions.utils")
@@ -49,15 +53,15 @@ end
 function getAnimationForCustomDoor(self, effect)
     local freshlySpawned = effect.FrameCount == 0
     repeat
-        local ____switch11 = effect.State
-        local ____cond11 = ____switch11 == DoorState.STATE_OPEN
-        if ____cond11 then
+        local ____switch12 = effect.State
+        local ____cond12 = ____switch12 == DoorState.STATE_OPEN
+        if ____cond12 then
             do
                 return freshlySpawned and "Opened" or "Open"
             end
         end
-        ____cond11 = ____cond11 or ____switch11 == DoorState.STATE_CLOSED
-        if ____cond11 then
+        ____cond12 = ____cond12 or ____switch12 == DoorState.STATE_CLOSED
+        if ____cond12 then
             do
                 return freshlySpawned and "Closed" or "Close"
             end
@@ -89,33 +93,33 @@ function postEffectRenderCustomEntity(self, effect)
 end
 function isPlayerPastDoorThreshold(self, effect, player, direction)
     repeat
-        local ____switch19 = direction
-        local ____cond19 = ____switch19 == Direction.NO_DIRECTION
-        if ____cond19 then
+        local ____switch20 = direction
+        local ____cond20 = ____switch20 == Direction.NO_DIRECTION
+        if ____cond20 then
             do
                 return false
             end
         end
-        ____cond19 = ____cond19 or ____switch19 == Direction.UP
-        if ____cond19 then
+        ____cond20 = ____cond20 or ____switch20 == Direction.UP
+        if ____cond20 then
             do
                 return player.Position.Y <= effect.Position.Y
             end
         end
-        ____cond19 = ____cond19 or ____switch19 == Direction.RIGHT
-        if ____cond19 then
+        ____cond20 = ____cond20 or ____switch20 == Direction.RIGHT
+        if ____cond20 then
             do
                 return player.Position.X >= effect.Position.X
             end
         end
-        ____cond19 = ____cond19 or ____switch19 == Direction.DOWN
-        if ____cond19 then
+        ____cond20 = ____cond20 or ____switch20 == Direction.DOWN
+        if ____cond20 then
             do
                 return player.Position.Y >= effect.Position.Y
             end
         end
-        ____cond19 = ____cond19 or ____switch19 == Direction.LEFT
-        if ____cond19 then
+        ____cond20 = ____cond20 or ____switch20 == Direction.LEFT
+        if ____cond20 then
             do
                 return player.Position.X <= effect.Position.X
             end
@@ -127,6 +131,13 @@ function isPlayerPastDoorThreshold(self, effect, player, direction)
         end
     until true
 end
+function roomClearChange(self, roomClear, effectVariant)
+    local state = roomClear and DoorState.STATE_OPEN or DoorState.STATE_CLOSED
+    local customDoors = getEffects(nil, effectVariant)
+    for ____, customDoor in ipairs(customDoors) do
+        customDoor.State = state
+    end
+end
 function getPositionOffset(self, doorSlot)
     local direction = doorSlotToDirection(nil, doorSlot)
     local vector = directionToVector(nil, direction)
@@ -145,6 +156,12 @@ function ____exports.initCustomDoor(self, mod, effectVariant)
     initializedEffectVariants:add(effectVariant)
     mod:AddCallback(ModCallbacks.MC_POST_EFFECT_UPDATE, postEffectUpdaterCustomEntity, effectVariant)
     mod:AddCallback(ModCallbacks.MC_POST_EFFECT_RENDER, postEffectRenderCustomEntity, effectVariant)
+    mod:AddCallbackCustom(
+        ModCallbacksCustom.MC_ROOM_CLEAR_CHANGE,
+        function(____, roomClear)
+            roomClearChange(nil, roomClear, effectVariant)
+        end
+    )
 end
 function ____exports.spawnCustomDoor(self, effectVariant, doorSlot)
     if not initializedEffectVariants:has(effectVariant) then

package/dist/callbacks/postGridEntityCollision.lua

@@ -7,13 +7,13 @@ local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
 local hasSubscriptions, postUpdate, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____gridEntity = require("functions.gridEntity")
 local getCollidingEntitiesWithGridEntity = ____gridEntity.getCollidingEntitiesWithGridEntity
 local getGridEntities = ____gridEntity.getGridEntities
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
 local ____postGridEntityCollision = require("callbacks.subscriptions.postGridEntityCollision")
 local postGridEntityCollisionFire = ____postGridEntityCollision.postGridEntityCollisionFire
 local postGridEntityCollisionHasSubscriptions = ____postGridEntityCollision.postGridEntityCollisionHasSubscriptions

package/dist/callbacks/postPlayerChangeHealth.lua

@@ -4,6 +4,12 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local hasSubscriptions, postPEffectUpdateReordered, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____HealthType = require("enums.HealthType")
+local HealthType = ____HealthType.HealthType
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____player = require("functions.player")
@@ -12,12 +18,6 @@ local ____playerHealth = require("functions.playerHealth")
 local getPlayerHealthType = ____playerHealth.getPlayerHealthType
 local ____utils = require("functions.utils")
 local getEnumValues = ____utils.getEnumValues
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
-local ____HealthType = require("types.HealthType")
-local HealthType = ____HealthType.HealthType
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____postPlayerChangeHealth = require("callbacks.subscriptions.postPlayerChangeHealth")
 local postPlayerChangeHealthFire = ____postPlayerChangeHealth.postPlayerChangeHealthFire
 local postPlayerChangeHealthHasSubscriptions = ____postPlayerChangeHealth.postPlayerChangeHealthHasSubscriptions

package/dist/callbacks/postPlayerChangeType.lua

@@ -3,15 +3,15 @@ local ____lualib = require("lualib_bundle")
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local hasSubscriptions, postPEffectUpdateReordered, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____playerDataStructures = require("functions.playerDataStructures")
 local defaultMapGetPlayer = ____playerDataStructures.defaultMapGetPlayer
 local mapSetPlayer = ____playerDataStructures.mapSetPlayer
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____postPlayerChangeType = require("callbacks.subscriptions.postPlayerChangeType")
 local postPlayerChangeTypeFire = ____postPlayerChangeType.postPlayerChangeTypeFire
 local postPlayerChangeTypeHasSubscriptions = ____postPlayerChangeType.postPlayerChangeTypeHasSubscriptions

package/dist/callbacks/postPurchase.lua

@@ -4,6 +4,10 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local ____exports = {}
 local hasSubscriptions, postPEffectUpdateReordered, playerPickedUpNewItem, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____pickups = require("functions.pickups")
@@ -11,10 +15,6 @@ local getPickups = ____pickups.getPickups
 local ____playerDataStructures = require("functions.playerDataStructures")
 local defaultMapGetPlayer = ____playerDataStructures.defaultMapGetPlayer
 local mapSetPlayer = ____playerDataStructures.mapSetPlayer
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____postPurchase = require("callbacks.subscriptions.postPurchase")
 local postPurchaseFire = ____postPurchase.postPurchaseFire
 local postPurchaseHasSubscriptions = ____postPurchase.postPurchaseHasSubscriptions

package/dist/callbacks/postSlotRender.lua

@@ -4,12 +4,12 @@ local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local hasSubscriptions, postRender, checkSlotAnimationChanged, checkSlotBroken, BROKEN_ANIMATIONS, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____entitySpecific = require("functions.entitySpecific")
 local getSlots = ____entitySpecific.getSlots
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
 local ____postSlotAnimationChanged = require("callbacks.subscriptions.postSlotAnimationChanged")
 local postSlotAnimationChangedFire = ____postSlotAnimationChanged.postSlotAnimationChangedFire
 local postSlotAnimationChangedHasSubscriptions = ____postSlotAnimationChanged.postSlotAnimationChangedHasSubscriptions

package/dist/callbacks/postTransformation.lua

@@ -5,16 +5,16 @@ local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local hasSubscriptions, postPEffectUpdateReordered, VALID_TRANSFORMATIONS, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____math = require("functions.math")
 local range = ____math.range
 local ____playerDataStructures = require("functions.playerDataStructures")
 local defaultMapGetPlayer = ____playerDataStructures.defaultMapGetPlayer
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____postTransformation = require("callbacks.subscriptions.postTransformation")
 local postTransformationFire = ____postTransformation.postTransformationFire
 local postTransformationHasSubscriptions = ____postTransformation.postTransformationHasSubscriptions

package/dist/callbacks/postTrinketBreak.lua

@@ -3,14 +3,14 @@ local ____lualib = require("lualib_bundle")
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local hasSubscriptions, entityTakeDmgPlayer, postPEffectUpdateReordered, TRINKETS_THAT_CAN_BREAK, v
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
 local saveDataManager = ____exports.saveDataManager
 local ____playerDataStructures = require("functions.playerDataStructures")
 local defaultMapGetPlayer = ____playerDataStructures.defaultMapGetPlayer
-local ____DefaultMap = require("types.DefaultMap")
-local DefaultMap = ____DefaultMap.DefaultMap
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____postTrinketBreak = require("callbacks.subscriptions.postTrinketBreak")
 local postTrinketBreakFire = ____postTrinketBreak.postTrinketBreakFire
 local postTrinketBreakHasSubscriptions = ____postTrinketBreak.postTrinketBreakHasSubscriptions

package/dist/callbacks/preBerserkDeath.lua

@@ -1,13 +1,13 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
 local hasSubscriptions, postPEffectUpdateReordered
+local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
+local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____player = require("functions.player")
 local getPlayerNumHitsRemaining = ____player.getPlayerNumHitsRemaining
 local isChildPlayer = ____player.isChildPlayer
 local ____revive = require("functions.revive")
 local willPlayerRevive = ____revive.willPlayerRevive
-local ____ModCallbacksCustom = require("types.ModCallbacksCustom")
-local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____preBerserkDeath = require("callbacks.subscriptions.preBerserkDeath")
 local preBerserkDeathFire = ____preBerserkDeath.preBerserkDeathFire
 local preBerserkDeathHasSubscriptions = ____preBerserkDeath.preBerserkDeathHasSubscriptions

package/dist/callbacks/roomClearChange.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/callbacks/roomClearChange.lua

@@ -0,0 +1,39 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local hasSubscriptions, postUpdate, postNewRoom, v
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____exports = require("features.saveDataManager.exports")
+local saveDataManager = ____exports.saveDataManager
+local ____roomClearChange = require("callbacks.subscriptions.roomClearChange")
+local roomClearChangedFire = ____roomClearChange.roomClearChangedFire
+local roomClearChangedHasSubscriptions = ____roomClearChange.roomClearChangedHasSubscriptions
+function hasSubscriptions(self)
+    return roomClearChangedHasSubscriptions(nil)
+end
+function postUpdate(self)
+    if not hasSubscriptions(nil) then
+        return
+    end
+    local room = game:GetRoom()
+    local roomClear = room:IsClear()
+    if roomClear ~= v.room.cleared then
+        v.room.cleared = roomClear
+        roomClearChangedFire(nil, roomClear)
+    end
+end
+function postNewRoom(self)
+    if not hasSubscriptions(nil) then
+        return
+    end
+    local room = game:GetRoom()
+    local roomClear = room:IsClear()
+    v.room.cleared = roomClear
+end
+v = {room = {cleared = false}}
+function ____exports.roomClearChangeCallbackInit(self, mod)
+    saveDataManager(nil, "roomClearChange", v, hasSubscriptions)
+    mod:AddCallback(ModCallbacks.MC_POST_UPDATE, postUpdate)
+    mod:AddCallback(ModCallbacks.MC_POST_NEW_ROOM, postNewRoom)
+end
+return ____exports

package/dist/callbacks/subscriptions/postPlayerChangeHealth.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="isaac-typescript-definitions" />
-import { HealthType } from "../../types/HealthType";
+import { HealthType } from "../../enums/HealthType";
 export declare type PostPlayerChangeHealthCallbackType = (player: EntityPlayer, healthType: HealthType, amount: int) => void;

package/dist/callbacks/subscriptions/roomClearChange.d.ts

@@ -0,0 +1 @@
+export declare type RoomClearChangeCallbackType = (roomClear: boolean) => void;

package/dist/callbacks/subscriptions/roomClearChange.lua

@@ -0,0 +1,18 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayPush = ____lualib.__TS__ArrayPush
+local ____exports = {}
+local subscriptions = {}
+function ____exports.roomClearChangedHasSubscriptions(self)
+    return #subscriptions > 0
+end
+function ____exports.roomClearChangedRegister(self, callback)
+    __TS__ArrayPush(subscriptions, {callback})
+end
+function ____exports.roomClearChangedFire(self, roomClear)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        callback(nil, roomClear)
+    end
+end
+return ____exports

package/dist/classes/DefaultMap.d.ts

@@ -0,0 +1,74 @@
+declare type FactoryFunction<K, V, A extends unknown[]> = (k: K, ...extraArgs: A) => V;
+declare type FirstArg<K, V, A extends unknown[]> = Iterable<[K, V]> | V | FactoryFunction<K, V, A>;
+declare type SecondArg<K, V, A extends unknown[]> = V | FactoryFunction<K, V, A>;
+/**
+ * An extended Map with some new methods:
+ *
+ * - `getAndSetDefault` - If the key exists, this will return the same thing as the `get` method.
+ *   Otherwise, it will set a default value to the key, and then return the default value.
+ * - `getDefaultValue` - Returns the default value to be used for a new key. (If a factory function
+ *   was provided during instantiation, this will execute the factory function.)
+ * - `getConstructorArg` - Helper method for cloning the map. Returns either the default value or
+ *   the reference to the factory function.
+ *
+ * When instantiating a new DefaultMap, you must specify either a default value or a function that
+ * returns a default value.
+ *
+ * Example:
+ * ```ts
+ * // Initializes a new empty DefaultMap with a default value of "foo"
+ * const defaultMapWithPrimitive = new DefaultMap<string, string>("foo");
+ *
+ * // Initializes a new empty DefaultMap with a default value of a new Map
+ * const defaultMapWithFactory = new DefaultMap<string, Map<string, string>>(() => {
+ *   return new Map();
+ * })
+ *
+ * // Initializes a DefaultMap with some initial values and a default value of "bar"
+ * const defaultMapWithInitialValues = new DefaultMap<string, string>([
+ *   ["a1", "a2"],
+ *   ["b1", "b2"],
+ * ], "bar");
+ * ```
+ *
+ * If specified, the first argument of a factory function must always be equal to the key:
+ *
+ * ```ts
+ * const defaultMapWithConditionalDefaultValue = new DefaultMap<number, number>((key: number) => {
+ *   return isOdd(key) ? 0 : 1;
+ * });
+ * ```
+ *
+ * You can also specify a factory function that takes a generic amount of arguments beyond the
+ * first:
+ *
+ * ```ts
+ * const factoryFunction = (_key: string, arg2: boolean) => arg2 ? 0 : 1;
+ * const defaultMapWithExtraArgs = new DefaultMap<string, string, [arg2: boolean]>(factoryFunction);
+ * ```
+ */
+export declare class DefaultMap<K, V, A extends unknown[] = []> extends Map<K, V> {
+    private defaultValue;
+    private defaultValueFactory;
+    /**
+     * See the DefaultMap documentation:
+     * https://isaacscript.github.io/isaacscript-common/classes/types_DefaultMap.DefaultMap.html
+     */
+    constructor(iterableOrDefaultValueOrDefaultValueFactory: FirstArg<K, V, A>, defaultValueOrDefaultValueFactory?: SecondArg<K, V, A>);
+    /**
+     * If the key exists, this will return the same thing as the `get` method. Otherwise, it will set
+     * a default value to the key, and then return the default value.
+     */
+    getAndSetDefault(key: K, ...extraArgs: A): V;
+    /**
+     * Returns the default value to be used for a new key. (If a factory function was provided during
+     * instantiation, this will execute the factory function.)
+     */
+    getDefaultValue(key: K, ...extraArgs: A): V;
+    /**
+     * Helper method for cloning the map. Returns either the default value or a reference to the
+     * factory function.
+     */
+    getConstructorArg(): V | FactoryFunction<K, V, A>;
+}
+export {};

package/dist/classes/DefaultMap.lua

@@ -0,0 +1,85 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local Map = ____lualib.Map
+local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__TypeOf = ____lualib.__TS__TypeOf
+local ____exports = {}
+local parseArguments, parseArgumentsOne, parseArgumentsTwo, parseDefaultValueOrDefaultValueFactory
+function parseArguments(self, firstArg, secondArg)
+    return secondArg == nil and parseArgumentsOne(nil, firstArg) or parseArgumentsTwo(nil, firstArg, secondArg)
+end
+function parseArgumentsOne(self, firstArg)
+    local arg = firstArg
+    local ____parseDefaultValueOrDefaultValueFactory_result_1 = parseDefaultValueOrDefaultValueFactory(nil, arg)
+    local defaultValue = ____parseDefaultValueOrDefaultValueFactory_result_1.defaultValue
+    local defaultValueFactory = ____parseDefaultValueOrDefaultValueFactory_result_1.defaultValueFactory
+    return {iterable = nil, defaultValue = defaultValue, defaultValueFactory = defaultValueFactory}
+end
+function parseArgumentsTwo(self, firstArg, secondArg)
+    local firstArgType = type(firstArg)
+    if firstArgType ~= "table" then
+        error("A DefaultMap constructor with two arguments must have the first argument be the initializer list.")
+    end
+    local ____parseDefaultValueOrDefaultValueFactory_result_2 = parseDefaultValueOrDefaultValueFactory(nil, secondArg)
+    local defaultValue = ____parseDefaultValueOrDefaultValueFactory_result_2.defaultValue
+    local defaultValueFactory = ____parseDefaultValueOrDefaultValueFactory_result_2.defaultValueFactory
+    return {iterable = firstArg, defaultValue = defaultValue, defaultValueFactory = defaultValueFactory}
+end
+function parseDefaultValueOrDefaultValueFactory(self, arg)
+    if type(arg) == "function" then
+        return {defaultValue = nil, defaultValueFactory = arg}
+    end
+    if type(arg) == "boolean" or type(arg) == "number" or type(arg) == "string" then
+        return {defaultValue = arg, defaultValueFactory = nil}
+    end
+    return error("A DefaultMap was instantiated with an unknown type of: " .. __TS__TypeOf(arg))
+end
+____exports.DefaultMap = __TS__Class()
+local DefaultMap = ____exports.DefaultMap
+DefaultMap.name = "DefaultMap"
+__TS__ClassExtends(DefaultMap, Map)
+function DefaultMap.prototype.____constructor(self, iterableOrDefaultValueOrDefaultValueFactory, defaultValueOrDefaultValueFactory)
+    local ____parseArguments_result_0 = parseArguments(nil, iterableOrDefaultValueOrDefaultValueFactory, defaultValueOrDefaultValueFactory)
+    local iterable = ____parseArguments_result_0.iterable
+    local defaultValue = ____parseArguments_result_0.defaultValue
+    local defaultValueFactory = ____parseArguments_result_0.defaultValueFactory
+    if defaultValue == nil and defaultValueFactory == nil then
+        error("A DefaultMap must be instantiated with either a default value or a function that returns a default value.")
+    end
+    if iterable == nil then
+        Map.prototype.____constructor(self)
+    else
+        Map.prototype.____constructor(self, iterable)
+    end
+    self.defaultValue = defaultValue
+    self.defaultValueFactory = defaultValueFactory
+end
+function DefaultMap.prototype.getAndSetDefault(self, key, ...)
+    local value = self:get(key)
+    if value ~= nil then
+        return value
+    end
+    local defaultValue = self:getDefaultValue(key, ...)
+    self:set(key, defaultValue)
+    return defaultValue
+end
+function DefaultMap.prototype.getDefaultValue(self, key, ...)
+    if self.defaultValue ~= nil then
+        return self.defaultValue
+    end
+    if self.defaultValueFactory ~= nil then
+        return self:defaultValueFactory(key, ...)
+    end
+    return error("A DefaultMap was incorrectly instantiated.")
+end
+function DefaultMap.prototype.getConstructorArg(self)
+    if self.defaultValue ~= nil then
+        return self.defaultValue
+    end
+    if self.defaultValueFactory ~= nil then
+        return self.defaultValueFactory
+    end
+    return error("A DefaultMap was incorrectly instantiated.")
+end
+return ____exports

package/dist/classes/ModUpgraded.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="isaac-typescript-definitions" />
+import { ModCallbacksCustom } from "../enums/ModCallbacksCustom";
+import { AddCallbackParametersCustom } from "../types/AddCallbackParametersCustom";
+/** `isaacscript-common` allows for custom callbacks, so it provides an upgraded Mod object. */
+export declare class ModUpgraded implements Mod {
+    Name: string;
+    /** We store a copy of the original mod object so that we can re-implement its functions. */
+    Mod: Mod;
+    /** End-users can optionally enable verbose-mode, which helps troubleshoot crashes. */
+    Verbose: boolean;
+    constructor(mod: Mod, verbose: boolean);
+    AddCallback<T extends ModCallbacks>(modCallbacks: T, ...args: AddCallbackParameters[T]): void;
+    HasData(): boolean;
+    LoadData(): string;
+    RemoveCallback(callbackID: ModCallbacks, callback: () => void): void;
+    RemoveData(): void;
+    SaveData(data: string): void;
+    AddCallbackCustom<T extends ModCallbacksCustom>(modCallbacksCustom: T, ...args: AddCallbackParametersCustom[T]): void;
+}

package/dist/classes/ModUpgraded.lua

@@ -0,0 +1,73 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__ObjectEntries = ____lualib.__TS__ObjectEntries
+local ____exports = {}
+local getCallbackName
+local ____log = require("functions.log")
+local getDebugPrependString = ____log.getDebugPrependString
+local ____callbackRegisterFunctions = require("objects.callbackRegisterFunctions")
+local CALLBACK_REGISTER_FUNCTIONS = ____callbackRegisterFunctions.CALLBACK_REGISTER_FUNCTIONS
+function getCallbackName(self, callbackID)
+    for ____, ____value in ipairs(__TS__ObjectEntries(ModCallbacks)) do
+        local key = ____value[1]
+        local value = ____value[2]
+        if value == callbackID then
+            return key
+        end
+    end
+    return "MC_UNKNOWN"
+end
+____exports.ModUpgraded = __TS__Class()
+local ModUpgraded = ____exports.ModUpgraded
+ModUpgraded.name = "ModUpgraded"
+function ModUpgraded.prototype.____constructor(self, mod, verbose)
+    self.Name = mod.Name
+    self.Mod = mod
+    self.Verbose = verbose
+end
+function ModUpgraded.prototype.AddCallback(self, modCallbacks, ...)
+    local args = {...}
+    if self.Verbose then
+        local callback = args[1]
+        local optionalArg = args[2]
+        local callbackName = getCallbackName(nil, modCallbacks)
+        local debugMsg = getDebugPrependString(nil, callbackName)
+        local function callbackWithLogger(____, ...)
+            Isaac.DebugString(debugMsg .. " - START")
+            local value = callback(nil, ...)
+            Isaac.DebugString((debugMsg .. " - END - ") .. tostring(value))
+            return value
+        end
+        self.Mod:AddCallback(modCallbacks, callbackWithLogger, optionalArg)
+    else
+        self.Mod:AddCallback(
+            modCallbacks,
+            __TS__Spread(args)
+        )
+    end
+end
+function ModUpgraded.prototype.HasData(self)
+    return self.Mod:HasData()
+end
+function ModUpgraded.prototype.LoadData(self)
+    return self.Mod:LoadData()
+end
+function ModUpgraded.prototype.RemoveCallback(self, callbackID, callback)
+    self.Mod:RemoveCallback(callbackID, callback)
+end
+function ModUpgraded.prototype.RemoveData(self)
+    self.Mod:RemoveData()
+end
+function ModUpgraded.prototype.SaveData(self, data)
+    self.Mod:SaveData(data)
+end
+function ModUpgraded.prototype.AddCallbackCustom(self, modCallbacksCustom, ...)
+    local callbackRegisterFunction = CALLBACK_REGISTER_FUNCTIONS[modCallbacksCustom]
+    if callbackRegisterFunction == nil then
+        error("Failed to find a callback registration function for custom callback: " .. tostring(modCallbacksCustom))
+    end
+    callbackRegisterFunction(nil, ...)
+end
+return ____exports