isaacscript-common 6.6.1-dev.2 → 6.6.1

package/classes/DefaultMap.d.ts

@@ -1,109 +0,0 @@
-/**
- * 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 = () => [];
- * 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;
-    /**
-     * 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>;
-}

package/classes/DefaultMap.js

@@ -1,145 +0,0 @@
-import { isFunction, isPrimitive } from "../functions/types";
-/**
- * `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 = () => [];
- * 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 class DefaultMap extends Map {
-    defaultValue;
-    defaultValueFactory;
-    /**
-     * See the main `DefaultMap` documentation:
-     * https://isaacscript.github.io/isaacscript-common/classes/classes_DefaultMap.DefaultMap
-     */
-    constructor(defaultValueOrFactoryFunction, initializerArray) {
-        const argIsPrimitive = isPrimitive(defaultValueOrFactoryFunction);
-        const argIsFunction = isFunction(defaultValueOrFactoryFunction);
-        if (!argIsPrimitive && !argIsFunction) {
-            error(`Failed to instantiate a DefaultMap since the provided default value was of type "${typeof defaultValueOrFactoryFunction}". This error usually means that you are trying to use an array (or some other non-primitive data structure that is passed by reference) as the default value. Instead, return the data structure in a factory function, like "() => []". See the DefaultMap documentation for more details.`);
-        }
-        super(initializerArray);
-        if (argIsFunction) {
-            this.defaultValue = undefined;
-            this.defaultValueFactory = defaultValueOrFactoryFunction;
-        }
-        else {
-            this.defaultValue = defaultValueOrFactoryFunction;
-            this.defaultValueFactory = undefined;
-        }
-    }
-    /**
-     * 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, ...extraArgs) {
-        const value = super.get(key);
-        if (value !== undefined) {
-            return value;
-        }
-        const defaultValue = this.getDefaultValue(...extraArgs);
-        this.set(key, defaultValue);
-        return defaultValue;
-    }
-    /**
-     * 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) {
-        if (this.defaultValue !== undefined) {
-            return this.defaultValue;
-        }
-        if (this.defaultValueFactory !== undefined) {
-            return this.defaultValueFactory(...extraArgs);
-        }
-        error("A DefaultMap was incorrectly instantiated.");
-    }
-    /**
-     * Helper method for cloning the map. Returns either the default value or a reference to the
-     * factory function.
-     */
-    getConstructorArg() {
-        if (this.defaultValue !== undefined) {
-            return this.defaultValue;
-        }
-        if (this.defaultValueFactory !== undefined) {
-            return this.defaultValueFactory;
-        }
-        error("A DefaultMap was incorrectly instantiated.");
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRGVmYXVsdE1hcC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvY2xhc3Nlcy9EZWZhdWx0TWFwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxVQUFVLEVBQUUsV0FBVyxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFXN0Q7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0ErRUc7QUFDSCxNQUFNLE9BQU8sVUFBb0QsU0FBUSxHQUd4RTtJQUNTLFlBQVksQ0FBb0I7SUFDaEMsbUJBQW1CLENBQTJDO0lBRXRFOzs7T0FHRztJQUNILFlBQ0UsNkJBQW1FLEVBQ25FLGdCQUF5QztRQUV6QyxNQUFNLGNBQWMsR0FBRyxXQUFXLENBQUMsNkJBQTZCLENBQUMsQ0FBQztRQUNsRSxNQUFNLGFBQWEsR0FBRyxVQUFVLENBQUMsNkJBQTZCLENBQUMsQ0FBQztRQUNoRSxJQUFJLENBQUMsY0FBYyxJQUFJLENBQUMsYUFBYSxFQUFFO1lBQ3JDLEtBQUssQ0FDSCxvRkFBb0YsT0FBTyw2QkFBNkIsOFJBQThSLENBQ3ZaLENBQUM7U0FDSDtRQUVELEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO1FBRXhCLElBQUksYUFBYSxFQUFFO1lBQ2pCLElBQUksQ0FBQyxZQUFZLEdBQUcsU0FBUyxDQUFDO1lBQzlCLElBQUksQ0FBQyxtQkFBbUIsR0FBRyw2QkFBNkIsQ0FBQztTQUMxRDthQUFNO1lBQ0wsSUFBSSxDQUFDLFlBQVksR0FBRyw2QkFBc0MsQ0FBQztZQUMzRCxJQUFJLENBQUMsbUJBQW1CLEdBQUcsU0FBUyxDQUFDO1NBQ3RDO0lBQ0gsQ0FBQztJQUVEOzs7T0FHRztJQUNILGdCQUFnQixDQUFDLEdBQVEsRUFBRSxHQUFHLFNBQWU7UUFDM0MsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUM3QixJQUFJLEtBQUssS0FBSyxTQUFTLEVBQUU7WUFDdkIsT0FBTyxLQUFLLENBQUM7U0FDZDtRQUVELE1BQU0sWUFBWSxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUMsR0FBRyxTQUFTLENBQUMsQ0FBQztRQUN4RCxJQUFJLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxZQUFZLENBQUMsQ0FBQztRQUM1QixPQUFPLFlBQVksQ0FBQztJQUN0QixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsZUFBZSxDQUFDLEdBQUcsU0FBZTtRQUNoQyxJQUFJLElBQUksQ0FBQyxZQUFZLEtBQUssU0FBUyxFQUFFO1lBQ25DLE9BQU8sSUFBSSxDQUFDLFlBQVksQ0FBQztTQUMxQjtRQUVELElBQUksSUFBSSxDQUFDLG1CQUFtQixLQUFLLFNBQVMsRUFBRTtZQUMxQyxPQUFPLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxDQUFDO1NBQy9DO1FBRUQsS0FBSyxDQUFDLDRDQUE0QyxDQUFDLENBQUM7SUFDdEQsQ0FBQztJQUVEOzs7T0FHRztJQUNILGlCQUFpQjtRQUNmLElBQUksSUFBSSxDQUFDLFlBQVksS0FBSyxTQUFTLEVBQUU7WUFDbkMsT0FBTyxJQUFJLENBQUMsWUFBWSxDQUFDO1NBQzFCO1FBRUQsSUFBSSxJQUFJLENBQUMsbUJBQW1CLEtBQUssU0FBUyxFQUFFO1lBQzFDLE9BQU8sSUFBSSxDQUFDLG1CQUFtQixDQUFDO1NBQ2pDO1FBRUQsS0FBSyxDQUFDLDRDQUE0QyxDQUFDLENBQUM7SUFDdEQsQ0FBQztDQUNGIn0=

package/classes/DefaultMap.lua

@@ -1,136 +0,0 @@
-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 ____types = require("functions.types")
-local isFunction = ____types.isFunction
-local isPrimitive = ____types.isPrimitive
---- `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 = () => [];
--- 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.
-____exports.DefaultMap = __TS__Class()
-local DefaultMap = ____exports.DefaultMap
-DefaultMap.name = "DefaultMap"
-__TS__ClassExtends(DefaultMap, Map)
-function DefaultMap.prototype.____constructor(self, defaultValueOrFactoryFunction, initializerArray)
-    local argIsPrimitive = isPrimitive(nil, defaultValueOrFactoryFunction)
-    local argIsFunction = isFunction(nil, defaultValueOrFactoryFunction)
-    if not argIsPrimitive and not argIsFunction then
-        error(("Failed to instantiate a DefaultMap since the provided default value was of type \"" .. __TS__TypeOf(defaultValueOrFactoryFunction)) .. "\". This error usually means that you are trying to use an array (or some other non-primitive data structure that is passed by reference) as the default value. Instead, return the data structure in a factory function, like \"() => []\". See the DefaultMap documentation for more details.")
-    end
-    Map.prototype.____constructor(self, initializerArray)
-    if argIsFunction then
-        self.defaultValue = nil
-        self.defaultValueFactory = defaultValueOrFactoryFunction
-    else
-        self.defaultValue = defaultValueOrFactoryFunction
-        self.defaultValueFactory = nil
-    end
-end
-function DefaultMap.prototype.getAndSetDefault(self, key, ...)
-    local value = Map.prototype.get(self, key)
-    if value ~= nil then
-        return value
-    end
-    local defaultValue = self:getDefaultValue(...)
-    self:set(key, defaultValue)
-    return defaultValue
-end
-function DefaultMap.prototype.getDefaultValue(self, ...)
-    if self.defaultValue ~= nil then
-        return self.defaultValue
-    end
-    if self.defaultValueFactory ~= nil then
-        return self:defaultValueFactory(...)
-    end
-    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
-    error("A DefaultMap was incorrectly instantiated.")
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvY2xhc3Nlcy9EZWZhdWx0TWFwLnRzIl0sIm5hbWVzIjpbInRoaXMiXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLGtCQUF3QztBQUEvQjtBQUFZOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBMkZyQjtNQUFhO0FBQWI7QUFBaUUsK0JBQVE7QUFXdkUsb0RBQ0UsK0JBQ0E7QUFFTSwyQkFBaUIsaUJBQVk7QUFDN0IsMEJBQWdCLGdCQUFXO09BQzdCLElBQUMsdUJBQW1CO1FBQ3RCLE9BQ0Usd0ZBQW9GLGFBQU8sbUNBQTZCOztJQW5CdkQsb0NBdUIvRDtPQUVGO0FBQ0YsUUFBQUE7QUFDQSxRQUFBQSwyQkFBMkI7O0FBRTNCLFFBQUFBLG9CQUFvQjtBQUNwQixRQUFBQTs7QUFuQko7QUEyQkEscURBQWlCO0FBQ1Qsa0JBQVEsd0JBQVU7T0FDcEI7QUFDRixlQUFPOztBQUdILHlCQUFlLEFBQUFBLEtBQUssZ0JBQWdCO0lBQzFDLEFBQUFBLEtBQUssSUFBSSxLQUFLO0FBQ2QsV0FBTztBQVJUO0FBZUE7T0FDTSxBQUFBQTtBQUNGLGVBQU8sQUFBQUE7O09BR0wsQUFBQUE7QUFDRixlQUFPLEFBQUFBLEtBQUssb0JBQW9COztJQUdsQyxNQUFNO0FBVFI7QUFnQkE7T0FDTSxBQUFBQTtBQUNGLGVBQU8sQUFBQUE7O09BR0wsQUFBQUE7QUFDRixlQUFPLEFBQUFBOztJQUdULE1BQU07QUFUUiIsImZpbGUiOiJEZWZhdWx0TWFwLmx1YSIsInNvdXJjZVJvb3QiOiIifQ==

package/classes/ModUpgraded.d.ts

@@ -1,27 +0,0 @@
-import { ModCallback } from "isaac-typescript-definitions";
-import { ModCallbackCustom } from "../enums/ModCallbackCustom";
-import { AddCallbackParameterCustom } from "../interfaces/AddCallbackParameterCustom";
-/**
- * `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.
- */
-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;
-    constructor(mod: Mod);
-    AddCallback<T extends ModCallback>(modCallback: T, ...args: AddCallbackParameter[T]): void;
-    HasData(): boolean;
-    LoadData(): string;
-    /**
-     * This method does not care about the tertiary argument. Regardless of the conditions of how you
-     * registered the callback, it will be removed.
-     */
-    RemoveCallback<T extends ModCallback>(modCallback: T, callback: AddCallbackParameter[T][0]): void;
-    RemoveData(): void;
-    SaveData(data: string): void;
-    AddCallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...args: AddCallbackParameterCustom[T]): void;
-}

package/classes/ModUpgraded.js

@@ -1,57 +0,0 @@
-import { CALLBACK_REGISTER_FUNCTIONS } from "../objects/callbackRegisterFunctions";
-/**
- * `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.
- */
-export class ModUpgraded {
-    // -----------------
-    // Vanilla variables
-    // -----------------
-    Name; // The vanilla mod object stores this for some reason
-    // ----------------
-    // Custom variables
-    // ----------------
-    /** We store a copy of the original mod object so that we can re-implement its functions. */
-    Mod;
-    constructor(mod) {
-        this.Name = mod.Name;
-        this.Mod = mod;
-    }
-    // ---------------
-    // Vanilla methods
-    // ---------------
-    AddCallback(modCallback, ...args) {
-        this.Mod.AddCallback(modCallback, ...args);
-    }
-    HasData() {
-        return this.Mod.HasData();
-    }
-    LoadData() {
-        return this.Mod.LoadData();
-    }
-    /**
-     * This method does not care about the tertiary argument. Regardless of the conditions of how you
-     * registered the callback, it will be removed.
-     */
-    RemoveCallback(modCallback, callback) {
-        this.Mod.RemoveCallback(modCallback, callback);
-    }
-    RemoveData() {
-        this.Mod.RemoveData();
-    }
-    SaveData(data) {
-        this.Mod.SaveData(data);
-    }
-    // --------------
-    // Custom methods
-    // --------------
-    // eslint-disable-next-line class-methods-use-this
-    AddCallbackCustom(modCallbackCustom, ...args) {
-        const callbackRegisterFunction = CALLBACK_REGISTER_FUNCTIONS[modCallbackCustom];
-        callbackRegisterFunction(...args);
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiTW9kVXBncmFkZWQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9wYWNrYWdlcy9pc2FhY3NjcmlwdC1jb21tb24vc3JjL2NsYXNzZXMvTW9kVXBncmFkZWQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBR0EsT0FBTyxFQUFFLDJCQUEyQixFQUFFLE1BQU0sc0NBQXNDLENBQUM7QUFFbkY7Ozs7OztHQU1HO0FBQ0gsTUFBTSxPQUFPLFdBQVc7SUFDdEIsb0JBQW9CO0lBQ3BCLG9CQUFvQjtJQUNwQixvQkFBb0I7SUFFcEIsSUFBSSxDQUFTLENBQUMscURBQXFEO0lBRW5FLG1CQUFtQjtJQUNuQixtQkFBbUI7SUFDbkIsbUJBQW1CO0lBRW5CLDRGQUE0RjtJQUM1RixHQUFHLENBQU07SUFFVCxZQUFZLEdBQVE7UUFDbEIsSUFBSSxDQUFDLElBQUksR0FBRyxHQUFHLENBQUMsSUFBSSxDQUFDO1FBRXJCLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO0lBQ2pCLENBQUM7SUFFRCxrQkFBa0I7SUFDbEIsa0JBQWtCO0lBQ2xCLGtCQUFrQjtJQUVsQixXQUFXLENBQ1QsV0FBYyxFQUNkLEdBQUcsSUFBNkI7UUFFaEMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsV0FBVyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDN0MsQ0FBQztJQUVELE9BQU87UUFDTCxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDNUIsQ0FBQztJQUVELFFBQVE7UUFDTixPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsUUFBUSxFQUFFLENBQUM7SUFDN0IsQ0FBQztJQUVEOzs7T0FHRztJQUNILGNBQWMsQ0FDWixXQUFjLEVBQ2QsUUFBb0M7UUFFcEMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsV0FBVyxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQ2pELENBQUM7SUFFRCxVQUFVO1FBQ1IsSUFBSSxDQUFDLEdBQUcsQ0FBQyxVQUFVLEVBQUUsQ0FBQztJQUN4QixDQUFDO0lBRUQsUUFBUSxDQUFDLElBQVk7UUFDbkIsSUFBSSxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDMUIsQ0FBQztJQUVELGlCQUFpQjtJQUNqQixpQkFBaUI7SUFDakIsaUJBQWlCO0lBRWpCLGtEQUFrRDtJQUNsRCxpQkFBaUIsQ0FDZixpQkFBb0IsRUFDcEIsR0FBRyxJQUFtQztRQUV0QyxNQUFNLHdCQUF3QixHQUM1QiwyQkFBMkIsQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDO1FBQ2pELHdCQUF3QixDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDcEMsQ0FBQztDQUNGIn0=

package/classes/ModUpgraded.lua

@@ -1,42 +0,0 @@
-local ____lualib = require("lualib_bundle")
-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 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()
-local ModUpgraded = ____exports.ModUpgraded
-ModUpgraded.name = "ModUpgraded"
-function ModUpgraded.prototype.____constructor(self, mod)
-    self.Name = mod.Name
-    self.Mod = mod
-end
-function ModUpgraded.prototype.AddCallback(self, modCallback, ...)
-    self.Mod:AddCallback(modCallback, ...)
-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, modCallback, callback)
-    self.Mod:RemoveCallback(modCallback, 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, modCallbackCustom, ...)
-    local callbackRegisterFunction = CALLBACK_REGISTER_FUNCTIONS[modCallbackCustom]
-    callbackRegisterFunction(nil, ...)
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvY2xhc3Nlcy9Nb2RVcGdyYWRlZC50cyJdLCJuYW1lcyI6WyJ0aGlzIl0sIm1hcHBpbmdzIjoiOzs7QUFHQSxzQ0FBNEM7QUFBbkM7Ozs7OztBQVNUO01BQWE7QUFBYjtBQWNFLHFEQUFZO0FBQ1YsSUFBQUEsWUFBWTtBQUVaLElBQUFBLFdBQVc7QUFIYjtBQVVBLGlEQUNFO0lBR0EsQUFBQUEsU0FBUyxZQUFZLGFBQWE7QUFKcEM7QUFPQTtBQUNFLFdBQU8sQUFBQUEsU0FBUztBQURsQjtBQUlBO0FBQ0UsV0FBTyxBQUFBQSxTQUFTO0FBRGxCO0FBUUEsb0RBQ0UsYUFDQTtJQUVBLEFBQUFBLFNBQVMsZUFBZSxhQUFhO0FBSnZDO0FBT0E7SUFDRSxBQUFBQSxTQUFTO0FBRFg7QUFJQSw4Q0FBUztJQUNQLEFBQUFBLFNBQVMsU0FBUztBQURwQjtBQVNBLHVEQUNFO0FBR00scUNBQ0osNEJBQTRCO0lBQzlCLDhCQUF5QjtBQU4zQiIsImZpbGUiOiJNb2RVcGdyYWRlZC5sdWEiLCJzb3VyY2VSb290IjoiIn0=

package/constants.d.ts

@@ -1,139 +0,0 @@
-import { CollectibleType, ItemPoolType, LevelStage, RoomType } from "isaac-typescript-definitions";
-/**
- * The distance of the laser when Azazel does not have any range up items yet. For more info, see
- * the documentation for the `getAzazelBrimstoneDistance` function.
- */
-export declare const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
-/**
- * The path to the png file for collectible items during Curse of the Blind, making them appear with
- * a red question mark.
- */
-export declare const BLIND_ITEM_PNG_PATH = "gfx/items/collectibles/questionmark.png";
-/** 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_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;
-export declare const DOOR_HITBOX_RADIUS = 11;
-/**
- * When Eggies take fatal damage, they go into NpcState.STATE_SUICIDE and spawn 14 Swarm Spiders
- * while their StateFrame ticks upwards. The 14th spider appears when the StateFrame is at this
- * value.
- */
-export declare const EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45;
-/**
- * A non-existent or completely transparent PNG file for use in clearing sprites. For more
- * information, see the documentation for the `clearSprite` helper function.
- */
-export declare const EMPTY_PNG_PATH = "gfx/none.png";
-/**
- * The random items that appear when the player has TMTRAINER are generated on the fly as they are
- * encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The
- * second TMTRAINER item subtracts one from that, and so on.
- */
-export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType;
-/** Game frames are what is returned by the `Game.GetFrameCount` method. */
-export declare const GAME_FRAMES_PER_SECOND = 30;
-/** Render frames are what is returned by the `Isaac.GetFrameCount` method. */
-export declare const RENDER_FRAMES_PER_SECOND = 60;
-export declare const GRID_INDEX_CENTER_OF_1X1_ROOM = 67;
-/**
- * The floor is represented by a 13x13 grid. Room indexes start at 0. The first column is
- * represented by grid indexes 0, 13, 26, and so on.
- */
-export declare const LEVEL_GRID_COLUMN_HEIGHT = 13;
-/**
- * The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented
- * by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so
- * on.
- */
-export declare const LEVEL_GRID_ROW_WIDTH = 13;
-/**
- * The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented
- * by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so
- * on. The maximum room index possible is 168. (It is not 169 because we start at 0 instead of 1.)
- */
-export declare const MAX_LEVEL_GRID_INDEX = 168;
-/**
- * The game has a limit on the number of currently spawned familiars and will refuse to spawn any
- * more if it reaches the limit. Blue flies and blue spiders have a lower priority and will be
- * deleted to make room for other familiars.
- */
-export declare const MAX_NUM_FAMILIARS = 64;
-/** The game can only handle up to four different players. */
-export declare const MAX_NUM_INPUTS = 4;
-/** With Birthright, it is possible for Magdalene to have 18 heart containers. */
-export declare const MAX_PLAYER_HEART_CONTAINERS = 18;
-/**
- * As the player continues to move in a direction, they will accelerate. When going from one wall to
- * another in a 2x2 room at 2.0 speed (the maximum that the speed stat can rise to), the amount of
- * units moved per update frame will climb to around 9.797 as they hit the opposite wall. The
- * constant specifies a value of 9.8 to be safe.
- */
-export declare const MAX_PLAYER_SPEED_IN_UNITS = 9.8;
-export declare const MAX_PLAYER_TRINKET_SLOTS: number;
-/** If you set `EntityPlayer.ShotSpeed` lower than this value, it will have no effect. */
-export declare const MIN_PLAYER_SHOT_SPEED_STAT = 0.6;
-/** If you set `EntityPlayer.Speed` lower than this value, it will have no effect. */
-export declare const MIN_PLAYER_SPEED_STAT = 0.1;
-export declare const FIRST_ROOM_TYPE = RoomType.DEFAULT;
-export declare const LAST_ROOM_TYPE: RoomType;
-/**
- * The maximum speed stat that a player can have. Any additional speed beyond this will not take
- * effect.
- */
-export declare const MAX_SPEED_STAT = 2;
-/** This is in the center of the room. */
-export declare const NEW_FLOOR_STARTING_POSITION_NORMAL_MODE: Vector;
-/** This is near the top door. */
-export declare const NEW_FLOOR_STARTING_POSITION_GREED_MODE: Vector;
-/**
- * This is next to the bottom door. Presumably, the player does not start in the center of the room
- * (like they do when getting to a new stage) so that the controls graphic is more visible.
- */
-export declare const NEW_RUN_PLAYER_STARTING_POSITION: Vector;
-export declare const FIRST_STAGE = LevelStage.BASEMENT_1;
-export declare const LAST_STAGE: LevelStage;
-/** Corresponds to the maximum value for `EntityPlayer.SamsonBerserkCharge`. */
-export declare const MAX_TAINTED_SAMSON_BERSERK_CHARGE = 100000;
-export declare const NUM_DIMENSIONS: number;
-/**
- * The pill pool for each run is comprised of one effect for each unique pill color (minus gold and
- * horse pills.)
- */
-export declare const NUM_PILLS_IN_POOL: number;
-export declare const SECOND_IN_MILLISECONDS = 1000;
-export declare const MINUTE_IN_MILLISECONDS: number;
-export declare const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
-/** After taking damage, `EntityPlayer.SamsonBerserkCharge` is incremented by this amount. */
-export declare const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000;
-/**
- * This is the number of draw coordinates that each heart spans on the UI in the upper left hand
- * corner.
- */
-export declare const UI_HEART_WIDTH = 12;
-/**
- * This is a safer version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
- * is not safe to use.)
- */
-export declare const VectorOne: Readonly<Vector>;
-/**
- * This is a safer version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so
- * it is not safe to use.)
- */
-export declare const VectorZero: Readonly<Vector>;
-/**
- * This is a safer version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
- * so it is not safe to use.)
- *
- * If you need to mutate this, make a copy first with the `copyColor` helper function.
- */
-export declare const ColorDefault: Readonly<Color>;
-/**
- * Equal to `KColor(1, 1, 1, 1)`.
- *
- * If you need to mutate this, make a copy first with the `copyKColor` helper function.
- */
-export declare const KColorDefault: Readonly<KColor>;