isaacscript-common 2.3.0 → 3.0.0

package/callbacks/subscriptions/postSlotUpdate.lua

@@ -0,0 +1,29 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postSlotUpdateHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postSlotUpdateRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postSlotUpdateFire(self, slot)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local slotVariant = ____value[2]
+        do
+            if slotVariant ~= nil and slotVariant ~= slot.Variant then
+                goto __continue5
+            end
+            callback(nil, slot)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postSpikesRender.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare type PostSpikesRenderRegisterParameters = [
+    callback: (spikes: GridEntitySpikes) => void,
+    gridEntityVariant?: int
+];

package/callbacks/subscriptions/postSpikesRender.lua

@@ -0,0 +1,30 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postSpikesRenderHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postSpikesRenderRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postSpikesRenderFire(self, spikes)
+    local gridEntityVariant = spikes:GetVariant()
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local callbackGridEntityVariant = ____value[2]
+        do
+            if callbackGridEntityVariant ~= nil and callbackGridEntityVariant ~= gridEntityVariant then
+                goto __continue5
+            end
+            callback(nil, spikes)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postSpikesUpdate.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare type PostSpikesUpdateRegisterParameters = [
+    callback: (spikes: GridEntitySpikes) => void,
+    gridEntityVariant?: int
+];

package/callbacks/subscriptions/postSpikesUpdate.lua

@@ -0,0 +1,30 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postSpikesUpdateHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postSpikesUpdateRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postSpikesUpdateFire(self, spikes)
+    local gridEntityVariant = spikes:GetVariant()
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local callbackGridEntityVariant = ____value[2]
+        do
+            if callbackGridEntityVariant ~= nil and callbackGridEntityVariant ~= gridEntityVariant then
+                goto __continue5
+            end
+            callback(nil, spikes)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postTNTRender.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare type PostTNTRenderRegisterParameters = [
+    callback: (tnt: GridEntityTNT) => void,
+    gridEntityVariant?: int
+];

package/callbacks/subscriptions/postTNTRender.lua

@@ -0,0 +1,30 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postTNTRenderHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postTNTRenderRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postTNTRenderFire(self, tnt)
+    local gridEntityVariant = tnt:GetVariant()
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local callbackGridEntityVariant = ____value[2]
+        do
+            if callbackGridEntityVariant ~= nil and callbackGridEntityVariant ~= gridEntityVariant then
+                goto __continue5
+            end
+            callback(nil, tnt)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postTNTUpdate.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare type PostTNTUpdateRegisterParameters = [
+    callback: (tnt: GridEntityTNT) => void,
+    gridEntityVariant?: int
+];

package/callbacks/subscriptions/postTNTUpdate.lua

@@ -0,0 +1,30 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postTNTUpdateHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postTNTUpdateRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postTNTUpdateFire(self, tnt)
+    local gridEntityVariant = tnt:GetVariant()
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local callbackGridEntityVariant = ____value[2]
+        do
+            if callbackGridEntityVariant ~= nil and callbackGridEntityVariant ~= gridEntityVariant then
+                goto __continue5
+            end
+            callback(nil, tnt)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postTearInitLate.d.ts

@@ -0,0 +1,5 @@
+import { TearVariant } from "isaac-typescript-definitions";
+export declare type PostTearInitLateRegisterParameters = [
+    callback: (tear: EntityTear) => void,
+    tearVariant?: TearVariant
+];

package/callbacks/subscriptions/postTearInitLate.lua

@@ -0,0 +1,29 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postTearInitLateHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postTearInitLateRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postTearInitLateFire(self, tear)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local tearVariant = ____value[2]
+        do
+            if tearVariant ~= nil and tearVariant ~= tear.Variant then
+                goto __continue5
+            end
+            callback(nil, tear)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postTearInitVeryLate.d.ts

@@ -0,0 +1,5 @@
+import { TearVariant } from "isaac-typescript-definitions";
+export declare type PostTearInitVeryLateRegisterParameters = [
+    callback: (tear: EntityTear) => void,
+    tearVariant?: TearVariant
+];

package/callbacks/subscriptions/postTearInitVeryLate.lua

@@ -0,0 +1,29 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postTearInitVeryLateHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postTearInitVeryLateRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postTearInitVeryLateFire(self, tear)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local tearVariant = ____value[2]
+        do
+            if tearVariant ~= nil and tearVariant ~= tear.Variant then
+                goto __continue5
+            end
+            callback(nil, tear)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postTransformation.d.ts

@@ -0,0 +1,5 @@
+import { PlayerForm } from "isaac-typescript-definitions";
+export declare type PostTransformationRegisterParameters = [
+    callback: (player: EntityPlayer, playerForm: PlayerForm, hasForm: boolean) => void,
+    playerForm?: PlayerForm
+];

package/callbacks/subscriptions/postTransformation.lua

@@ -0,0 +1,29 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postTransformationHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postTransformationRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postTransformationFire(self, player, playerForm, hasForm)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local callbackPlayerForm = ____value[2]
+        do
+            if callbackPlayerForm ~= nil and callbackPlayerForm ~= playerForm then
+                goto __continue5
+            end
+            callback(nil, player, playerForm, hasForm)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/postTrinketBreak.d.ts

@@ -0,0 +1,5 @@
+import { TrinketType } from "isaac-typescript-definitions";
+export declare type PostTrinketBreakRegisterParameters = [
+    callback: (player: EntityPlayer, trinketType: TrinketType) => void,
+    trinketType?: TrinketType
+];

package/callbacks/subscriptions/postTrinketBreak.lua

@@ -0,0 +1,29 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.postTrinketBreakHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.postTrinketBreakRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.postTrinketBreakFire(self, player, trinketType)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local callbackTrinketType = ____value[2]
+        do
+            if callbackTrinketType ~= nil and callbackTrinketType ~= trinketType then
+                goto __continue5
+            end
+            callback(nil, player, trinketType)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/preBerserkDeath.d.ts

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

package/callbacks/subscriptions/preBerserkDeath.lua

@@ -0,0 +1,35 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.preBerserkDeathHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.preBerserkDeathRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.preBerserkDeathFire(self, player)
+    local character = player:GetPlayerType()
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local playerVariant = ____value[2]
+        local callbackCharacter = ____value[3]
+        do
+            if playerVariant ~= nil and playerVariant ~= player.Variant then
+                goto __continue5
+            end
+            if callbackCharacter ~= nil and callbackCharacter ~= character then
+                goto __continue5
+            end
+            callback(nil, player)
+        end
+        ::__continue5::
+    end
+    return nil
+end
+return ____exports

package/callbacks/subscriptions/preCustomRevive.d.ts

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

package/callbacks/subscriptions/preCustomRevive.lua

@@ -0,0 +1,38 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.preCustomReviveHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.preCustomReviveRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.preCustomReviveFire(self, player)
+    local character = player:GetPlayerType()
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local playerVariant = ____value[2]
+        local callbackCharacter = ____value[3]
+        do
+            if playerVariant ~= nil and playerVariant ~= player.Variant then
+                goto __continue5
+            end
+            if callbackCharacter ~= nil and callbackCharacter ~= character then
+                goto __continue5
+            end
+            local revivalType = callback(nil, player)
+            if revivalType ~= nil then
+                return revivalType
+            end
+        end
+        ::__continue5::
+    end
+    return nil
+end
+return ____exports

package/callbacks/subscriptions/preItemPickup.d.ts

@@ -0,0 +1,11 @@
+import { CollectibleType, ItemType, TrinketType } from "isaac-typescript-definitions";
+import { PickingUpItem, PickingUpItemCollectible, PickingUpItemTrinket } from "../../types/PickingUpItem";
+export declare type PreItemPickupRegisterParameters = [callback: (player: EntityPlayer, pickingUpItem: PickingUpItem) => void] | [
+    callback: (player: EntityPlayer, pickingUpItem: PickingUpItemCollectible) => void,
+    itemType: ItemType.PASSIVE | ItemType.ACTIVE | ItemType.FAMILIAR,
+    collectibleType?: CollectibleType
+] | [
+    callback: (player: EntityPlayer, pickingUpItem: PickingUpItemTrinket) => void,
+    itemType: ItemType.TRINKET,
+    trinketType?: TrinketType
+];

package/callbacks/subscriptions/preItemPickup.lua

@@ -0,0 +1,33 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.preItemPickupHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.preItemPickupRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.preItemPickupFire(self, player, pickingUpItem)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        local itemType = ____value[2]
+        local subType = ____value[3]
+        do
+            if itemType ~= nil and itemType ~= pickingUpItem.itemType then
+                goto __continue5
+            end
+            if subType ~= nil and subType ~= pickingUpItem.subType then
+                goto __continue5
+            end
+            callback(nil, player, pickingUpItem)
+        end
+        ::__continue5::
+    end
+end
+return ____exports

package/callbacks/subscriptions/preNewLevel.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare type PreNewLevelRegisterParameters = [
+    callback: (player: EntityPlayer) => void
+];

package/callbacks/subscriptions/preNewLevel.lua

@@ -0,0 +1,22 @@
+local ____exports = {}
+local subscriptions = {}
+---
+-- @internal
+function ____exports.preNewLevelHasSubscriptions(self)
+    return #subscriptions > 0
+end
+---
+-- @internal
+function ____exports.preNewLevelRegister(self, ...)
+    local args = {...}
+    subscriptions[#subscriptions + 1] = args
+end
+---
+-- @internal
+function ____exports.preNewLevelFire(self, player)
+    for ____, ____value in ipairs(subscriptions) do
+        local callback = ____value[1]
+        callback(nil, player)
+    end
+end
+return ____exports

package/classes/DefaultMap.d.ts

@@ -0,0 +1,110 @@
+/**
+ * A function that creates the default value for your `DefaultMap`. For example, if it was a
+ * `DefaultMap` containing maps, the factory function would be: `() => new Map()`
+ */
+export declare type FactoryFunction<V, Args extends unknown[]> = (...extraArgs: Args) => V;
+/**
+ * `DefaultMap` is a data structure that makes working with default values easier.
+ *
+ * It is a common pattern to look up a value in a `Map`, and then, if the value does not exist, set
+ * a default value for the key, and then return the default value. `DefaultMap` abstracts this
+ * operation away by providing the `getAndSetDefault` method.
+ *
+ * Using a `DefaultMap` is nice because it makes code more declarative, since you specify what the
+ * default value is alongside the types of the keys/values.
+ *
+ * When instantiating a new `DefaultMap`, you must specify default value as the first argument. (The
+ * default value is the initial value that will be assigned to every new entry in the
+ * `getAndSetDefault` method.) For example:
+ *
+ * ```ts
+ * // Initializes a new empty DefaultMap with a default value of "foo".
+ * const defaultMapWithString = new DefaultMap<string, string>("foo");
+ *
+ * const value = defaultMapWithString.getAndSetDefault("bar");
+ * // value is now "foo" and an entry for "bar" is now set.
+ * ```
+ *
+ * Sometimes, instead of having a static initial value for every entry in the map, you will want a
+ * dynamic initial value that is contingent upon the key or some other variable. In these cases, you
+ * can instead specify that the `DefaultMap` should run a function that will return the initial
+ * value. (This is referred to as a "factory function".) For example:
+ *
+ * ```ts
+ * // Initializes a new empty DefaultMap with a default value based on "someGlobalVariable".
+ * const factoryFunction = () => someGlobalVariable ? 0 : 1;
+ * const defaultMapWithFactoryFunction = new DefaultMap<string, string>(factoryFunction);
+ * ```
+ *
+ * Note that in TypeScript and Lua, booleans, numbers, and strings are "passed by value". This means
+ * that when the `DefaultMap` creates a new entry, if the default value is one of these 3 types, the
+ * values will be copied. On the other hand, arrays and maps and other complex data structures are
+ * "passed by reference". This means that when the `DefaultMap` creates a new entry, if the default
+ * value is an array, then it would not be copied. Instead, the same shared array would be assigned
+ * to every entry. Thus, to solve this problem, any variable that is passed by reference must be
+ * created using a factory function to ensure that each copy is unique. For example:
+ *
+ * ```ts
+ * // Initializes a new empty DefaultMap with a default value of a new empty array.
+ * const factoryFunction = () => [] as ;
+ * const defaultMapWithArray = new DefaultMap<string, string[]>(factoryFunction);
+ * ```
+ *
+ * In the previous two examples, the factory functions did not have any arguments. But you can also
+ * specify a factory function that takes one or more arguments:
+ *
+ * ```ts
+ * const factoryFunction = (arg: boolean) => arg ? 0 : 1;
+ * const defaultMapWithArg = new DefaultMap<string, string, [arg: boolean]>(factoryFunction);
+ * ```
+ *
+ * Similar to a normal `Map`, you can also include an initializer list in the constructor as the
+ * second argument:
+ *
+ * ```ts
+ * // Initializes a DefaultMap with a default value of "foo" and some initial values.
+ * const defaultMapWithInitialValues = new DefaultMap<string, string>("foo", [
+ *   ["a1", "a2"],
+ *   ["b1", "b2"],
+ * ], );
+ * ```
+ *
+ * Finally, note that `DefaultMap` has the following additional utility methods:
+ *
+ * - `getAndSetDefault` - The method that is called inside the overridden `get` method. In most
+ *   cases, you can use the overridden `get` method instead of calling this function directly.
+ *   However, if a factory function was provided during instantiation, and the factory function has
+ *   one or more arguments, then you must call this method instead (and provide the corresponding
+ *   arguments).
+ * - `getWithoutDefault` - Calls the original `Map.get` function (without setting 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.
+ */
+export declare class DefaultMap<Key, Value, Args extends unknown[] = []> extends Map<Key, Value> {
+    private defaultValue;
+    private defaultValueFactory;
+    /**
+     * See the main `DefaultMap` documentation:
+     * https://isaacscript.github.io/isaacscript-common/classes/classes_DefaultMap.DefaultMap
+     */
+    constructor(defaultValueOrFactoryFunction: Value | FactoryFunction<Value, Args>, initializerArray?: Iterable<[Key, Value]>);
+    /**
+     * If the key exists, this will return the same thing as the normal `Map.get` method. Otherwise,
+     * it will set a default value for the provided key, and then return the default value.
+     */
+    getAndSetDefault(key: Key, ...extraArgs: Args): Value;
+    getWithoutDefault(key: Key): Value | undefined;
+    /**
+     * 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(...extraArgs: Args): Value;
+    /**
+     * Helper method for cloning the map. Returns either the default value or a reference to the
+     * factory function.
+     */
+    getConstructorArg(): Value | FactoryFunction<Value, Args>;
+}