isaacscript-common 6.23.0 → 7.1.1

package/dist/features/disableInputs.d.ts

@@ -39,7 +39,7 @@ export declare function enableAllInputsExceptFor(key: string, blacklist: Set<But
  *            that multiple mod features can work in tandem.
  * @param whitelist A set of ButtonActions to allow.
  */
-export declare function disableAllInputsExceptFor(key: string, whitelist: Set<ButtonAction>): void;
+export declare function disableAllInputsExceptFor(key: string, whitelist: Set<ButtonAction> | ReadonlySet<ButtonAction>): void;
 /**
  * Helper function to disable only the inputs used for moving the character (or moving the cursor in
  * the UI). This is useful because `EntityPlayer.ControlsEnabled` can be changed by the game under

package/dist/features/disableInputs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"disableInputs.d.ts","sourceRoot":"","sources":["../../src/features/disableInputs.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AAuBtC,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAoBhD;AA+CD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAKjD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAKlD;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC,YAAY,CAAC,GACvD,IAAI,CAKN;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAC3B,IAAI,CAKN;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAGvD;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAGvD"}
+{"version":3,"file":"disableInputs.d.ts","sourceRoot":"","sources":["../../src/features/disableInputs.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAGb,MAAM,8BAA8B,CAAC;AAiBtC,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAoBhD;AA+CD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAKjD;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAKlD;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC,YAAY,CAAC,GACvD,IAAI,CAKN;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC,YAAY,CAAC,GACvD,IAAI,CAKN;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAGvD;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAGvD"}

package/dist/features/runInNFrames.lua

@@ -60,12 +60,7 @@ end
 local FEATURE_NAME = "runInNFrames"
 v = {run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}, intervalGameFunctionTuples = {}, intervalRenderFunctionTuples = {}}}
 function ____exports.runInNFramesInit(self, mod)
-    saveDataManager(
-        nil,
-        FEATURE_NAME,
-        v,
-        function() return false end
-    )
+    saveDataManager(nil, FEATURE_NAME, v, false)
     mod:AddCallback(ModCallback.POST_UPDATE, postUpdate)
     mod:AddCallback(ModCallback.POST_RENDER, postRender)
 end

package/dist/features/runNextRoom.lua

@@ -17,12 +17,7 @@ end
 local FEATURE_NAME = "runNextRoom"
 v = {run = {queuedFunctions = {}}}
 function ____exports.runNextRoomInit(self, mod)
-    saveDataManager(
-        nil,
-        FEATURE_NAME,
-        v,
-        function() return false end
-    )
+    saveDataManager(nil, FEATURE_NAME, v, false)
     mod:AddCallbackCustom(ModCallbackCustom.POST_NEW_ROOM_REORDERED, postNewRoomReordered)
 end
 --- Supply a function to run on the next `POST_NEW_ROOM` callback.

package/dist/features/saveDataManager/exports.d.ts

@@ -92,7 +92,7 @@ import { SaveData } from "../../interfaces/SaveData";
 export declare function saveDataManager<Persistent, Run, Level>(key: string, // This is the overload for the standard case with serializable data.
 v: SaveData<Persistent, Run, Level>, conditionalFunc?: () => boolean): void;
 export declare function saveDataManager(key: string, // This is the overload for the case when saving data is disabled.
-v: SaveData<unknown, unknown, unknown>, conditionalFunc: false): void;
+v: SaveData, conditionalFunc: false): void;
 /**
  * The save data manager will automatically load variables from disk at the appropriate times (i.e.
  * when a new run is started). Use this function to explicitly force the save data manager to load

package/dist/features/saveDataManager/exports.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../src/features/saveDataManager/exports.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAarD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EACpD,GAAG,EAAE,MAAM,EAAE,qEAAqE;AAClF,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,EACnC,eAAe,CAAC,EAAE,MAAM,OAAO,GAC9B,IAAI,CAAC;AACR,wBAAgB,eAAe,CAC7B,GAAG,EAAE,MAAM,EAAE,kEAAkE;AAC/E,CAAC,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EACtC,eAAe,EAAE,KAAK,GACrB,IAAI,CAAC;AA+CR;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAQD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAK/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,MAAM,GACrB,IAAI,CAiBN"}
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../src/features/saveDataManager/exports.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAarD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EACpD,GAAG,EAAE,MAAM,EAAE,qEAAqE;AAClF,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,EACnC,eAAe,CAAC,EAAE,MAAM,OAAO,GAC9B,IAAI,CAAC;AACR,wBAAgB,eAAe,CAC7B,GAAG,EAAE,MAAM,EAAE,kEAAkE;AAC/E,CAAC,EAAE,QAAQ,EACX,eAAe,EAAE,KAAK,GACrB,IAAI,CAAC;AA+CR;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C;AAQD;;;;;;GAMG;AACH,wBAAgB,wBAAwB,IAAI,IAAI,CAK/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,MAAM,GACrB,IAAI,CAiBN"}

package/dist/features/saveDataManager/merge.d.ts

@@ -10,6 +10,7 @@
  * - TSTL `Set`
  * - TSTL classes
  * - `DefaultMap`
+ * - Isaac `BitSet128` objects
  * - Isaac `Color` objects
  * - Isaac `KColor` objects
  * - Isaac `RNG` objects

package/dist/features/saveDataManager/merge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"merge.d.ts","sourceRoot":"","sources":["../../../src/features/saveDataManager/merge.ts"],"names":[],"mappings":";AAgBA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,KAAK,CACnB,SAAS,EACL,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAC1B,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GACvB,GAAG,CAAC,SAAS,CAAC,EAClB,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,EACpC,oBAAoB,EAAE,MAAM,GAC3B,IAAI,CA2BN"}
+{"version":3,"file":"merge.d.ts","sourceRoot":"","sources":["../../../src/features/saveDataManager/merge.ts"],"names":[],"mappings":";AAgBA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,KAAK,CACnB,SAAS,EACL,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAC1B,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,GACvB,GAAG,CAAC,SAAS,CAAC,EAClB,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,EACpC,oBAAoB,EAAE,MAAM,GAC3B,IAAI,CA2BN"}

package/dist/features/saveDataManager/merge.lua

@@ -41,6 +41,7 @@ local isSerializationBrand = ____serializationBrands.isSerializationBrand
 -- - TSTL `Set`
 -- - TSTL classes
 -- - `DefaultMap`
+-- - Isaac `BitSet128` objects
 -- - Isaac `Color` objects
 -- - Isaac `KColor` objects
 -- - Isaac `RNG` objects

package/dist/functions/bitSet128.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/// <reference types="isaac-typescript-definitions" />
+export declare type SerializedBitSet128 = LuaMap<string, unknown> & {
+    readonly __serializedBitSet128Brand: symbol;
+};
+/** Helper function to copy a `BitSet128` Isaac API class. */
+export declare function copyBitSet128(bitSet128: BitSet128): BitSet128;
+/**
+ * Helper function to convert a `SerializedBitSet128` object to a normal `BitSet128` object. (This
+ * is used by the save data manager when reading data from the "save#.dat" file.)
+ */
+export declare function deserializeBitSet128(bitSet128: SerializedBitSet128): BitSet128;
+/** Helper function to check if something is an instantiated `BitSet128` object. */
+export declare function isBitSet128(object: unknown): object is BitSet128;
+/**
+ * Used to determine is the given table is a serialized `BitSet128` object created by the save data
+ * manager and/or the `deepCopy` function.
+ */
+export declare function isSerializedBitSet128(object: unknown): object is SerializedBitSet128;
+/**
+ * Helper function to convert a `BitSet128` object to a `SerializedBitSet128` object. (This is used
+ * by the save data manager when writing data from the "save#.dat" file.)
+ */
+export declare function serializeBitSet128(bitSet128: BitSet128): SerializedBitSet128;
+//# sourceMappingURL=bitSet128.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bitSet128.d.ts","sourceRoot":"","sources":["../../src/functions/bitSet128.ts"],"names":[],"mappings":";;AAKA,oBAAY,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC1D,QAAQ,CAAC,0BAA0B,EAAE,MAAM,CAAC;CAC7C,CAAC;AAKF,6DAA6D;AAC7D,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,CAW7D;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,mBAAmB,GAC7B,SAAS,CAyBX;AAED,mFAAmF;AACnF,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,SAAS,CAEhE;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,mBAAmB,CAQ/B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,GAAG,mBAAmB,CAW5E"}

package/dist/functions/bitSet128.lua

@@ -0,0 +1,71 @@
+local ____exports = {}
+local OBJECT_NAME
+local ____SerializationBrand = require("enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
+local ____table = require("functions.table")
+local copyValuesToTable = ____table.copyValuesToTable
+local getNumbersFromTable = ____table.getNumbersFromTable
+local tableHasKeys = ____table.tableHasKeys
+local ____types = require("functions.types")
+local isTable = ____types.isTable
+--- Helper function to check if something is an instantiated `BitSet128` object.
+function ____exports.isBitSet128(self, object)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
+end
+OBJECT_NAME = "BitSet128"
+local KEYS = {"l", "h"}
+--- Helper function to copy a `BitSet128` Isaac API class.
+function ____exports.copyBitSet128(self, bitSet128)
+    if not ____exports.isBitSet128(nil, bitSet128) then
+        error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    local lowBits = bitSet128.l
+    local highBits = bitSet128.h
+    return BitSet128(lowBits, highBits)
+end
+--- Helper function to convert a `SerializedBitSet128` object to a normal `BitSet128` object. (This
+-- is used by the save data manager when reading data from the "save#.dat" file.)
+function ____exports.deserializeBitSet128(self, bitSet128)
+    if not isTable(nil, bitSet128) then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+    end
+    local l, h = table.unpack(getNumbersFromTable(
+        nil,
+        bitSet128,
+        OBJECT_NAME,
+        table.unpack(KEYS)
+    ))
+    if l == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: l")
+    end
+    if h == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: h")
+    end
+    return BitSet128(l, h)
+end
+--- Used to determine is the given table is a serialized `BitSet128` object created by the save data
+-- manager and/or the `deepCopy` function.
+function ____exports.isSerializedBitSet128(self, object)
+    if not isTable(nil, object) then
+        return false
+    end
+    return tableHasKeys(
+        nil,
+        object,
+        table.unpack(KEYS)
+    ) and object[SerializationBrand.BIT_SET_128] ~= nil
+end
+--- Helper function to convert a `BitSet128` object to a `SerializedBitSet128` object. (This is used
+-- by the save data manager when writing data from the "save#.dat" file.)
+function ____exports.serializeBitSet128(self, bitSet128)
+    if not ____exports.isBitSet128(nil, bitSet128) then
+        error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    local bitSet128Table = {}
+    copyValuesToTable(nil, bitSet128, KEYS, bitSet128Table)
+    bitSet128Table[SerializationBrand.BIT_SET_128] = ""
+    return bitSet128Table
+end
+return ____exports

package/dist/functions/collectibles.d.ts

@@ -218,8 +218,8 @@ export declare function setCollectibleGlitched(collectible: EntityPickup): void;
  */
 export declare function setCollectibleSprite(collectible: EntityPickup, pngPath: string | undefined): void;
 /**
- * Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
- * is not sufficient because the sprite will not change.
+ * Helper function to change the collectible on a pedestal. Simply updating the `SubType` field is
+ * not sufficient because the sprite will not change.
  */
 export declare function setCollectibleSubType(collectible: EntityPickup, newCollectibleType: CollectibleType): void;
 /**

package/dist/functions/collectibles.lua

@@ -84,8 +84,8 @@ function ____exports.setCollectibleSprite(self, collectible, pngPath)
         sprite:LoadGraphics()
     end
 end
---- Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
--- is not sufficient because the sprite will not change.
+--- Helper function to change the collectible on a pedestal. Simply updating the `SubType` field is
+-- not sufficient because the sprite will not change.
 function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
     if not isCollectible(nil, collectible) then
         local entityID = getEntityID(nil, collectible)

package/dist/functions/color.d.ts

@@ -21,7 +21,7 @@ export declare function deserializeColor(color: SerializedColor): Color;
  * @param alpha Optional. The alpha value to use. Default is 1.
  */
 export declare function getRandomColor(seedOrRNG?: Seed | RNG, alpha?: number): Color;
-/** Helper function to check if something is an instantiated Color object. */
+/** Helper function to check if something is an instantiated `Color` object. */
 export declare function isColor(object: unknown): object is Color;
 /**
  * Used to determine is the given table is a serialized `Color` object created by the save data

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

@@ -1 +1 @@
-{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../src/functions/color.ts"],"names":[],"mappings":";;;;AAOA,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACtD,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CACzC,CAAC;AAKF,wBAAgB,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,OAAO,CAEjE;AAED,yDAAyD;AACzD,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAgB7C;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,eAAe,GAAG,KAAK,CA8B9D;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,KAAK,SAAI,GACR,KAAK,CAQP;AAED,6EAA6E;AAC7E,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,KAAK,CAExD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,eAAe,CAM5E;AACD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,CAW5D"}
+{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../src/functions/color.ts"],"names":[],"mappings":";;;;AAOA,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACtD,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CACzC,CAAC;AAKF,wBAAgB,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,OAAO,CAEjE;AAED,yDAAyD;AACzD,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAgB7C;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,eAAe,GAAG,KAAK,CA8B9D;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,KAAK,SAAI,GACR,KAAK,CAQP;AAED,+EAA+E;AAC/E,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,KAAK,CAExD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,eAAe,CAM5E;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,CAW5D"}

package/dist/functions/color.lua

@@ -17,10 +17,11 @@ local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
 local ____types = require("functions.types")
 local isTable = ____types.isTable
---- Helper function to check if something is an instantiated Color object.
+--- Helper function to check if something is an instantiated `Color` object.
 function ____exports.isColor(self, object)
     return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
 end
+OBJECT_NAME = "Color"
 local KEYS = {
     "R",
     "G",
@@ -30,7 +31,6 @@ local KEYS = {
     "GO",
     "BO"
 }
-OBJECT_NAME = "Color"
 function ____exports.colorEquals(self, color1, color2)
     return isaacAPIClassEquals(nil, color1, color2, KEYS)
 end

package/dist/functions/deepCopy.d.ts

@@ -11,6 +11,7 @@ import { SerializationType } from "../enums/SerializationType";
  * - TSTL `Set`
  * - TSTL classes
  * - `DefaultMap`
+ * - Isaac `BitSet128` objects
  * - Isaac `Color` objects
  * - Isaac `KColor` objects
  * - Isaac `RNG` objects

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

@@ -1 +1 @@
-{"version":3,"file":"deepCopy.d.ts","sourceRoot":"","sources":["../../src/functions/deepCopy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AA6B/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,EACd,iBAAiB,oBAAyB,EAC1C,oBAAoB,SAAK,EACzB,SAAS,UAAQ,GAChB,OAAO,CAkDT"}
+{"version":3,"file":"deepCopy.d.ts","sourceRoot":"","sources":["../../src/functions/deepCopy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AA6B/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,EACd,iBAAiB,oBAAyB,EAC1C,oBAAoB,SAAK,EACzB,SAAS,UAAQ,GAChB,OAAO,CAkDT"}

package/dist/functions/deepCopy.lua

@@ -56,6 +56,7 @@ local twoDimensionalSort = ____utils.twoDimensionalSort
 -- - TSTL `Set`
 -- - TSTL classes
 -- - `DefaultMap`
+-- - Isaac `BitSet128` objects
 -- - Isaac `Color` objects
 -- - Isaac `KColor` objects
 -- - Isaac `RNG` objects
@@ -210,7 +211,7 @@ function deepCopyDefaultMap(self, defaultMap, serializationType, traversalDescri
     local constructorArg = ____isDefaultMap_result_0
     if serializationType == SerializationType.SERIALIZE and not isPrimitive(nil, constructorArg) then
         if insideMap then
-            error("Failed to deep copy a DefaultMap because it was instantiated with a factory function and was also inside of another map. You cannot use a nested DefaultMap in this way because factory functions are not serializable. (In other words, there is no way to copy the function that you are using for the DefaultMap into the \"save#.dat\" file.) Instead, refactor your data structure so that the DefaultMap is not nested.")
+            error("Failed to deep copy a DefaultMap because it was instantiated with a factory function and was also inside of an array, map, or set. For more information, see: https://isaacscript.github.io/main/gotchas#failed-to-deep-copy-a-defaultmap")
         else
             return deepCopyMap(
                 nil,

package/dist/functions/familiars.d.ts

@@ -7,8 +7,8 @@ import { CollectibleType, FamiliarVariant } from "isaac-typescript-definitions";
  * specify an incorrect RNG object. (The vanilla method is bugged in that it does not increment the
  * RNG object; see the documentation of the method for more details.)
  *
- * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
- * to `CacheFlag.FAMILIARS`).
+ * This function is meant to be called in the `EVALUATE_CACHE` callback (when the cache flag is
+ * equal to `CacheFlag.FAMILIARS`).
  *
  * Note that this function is only meant to be used in special circumstances where the familiar
  * count is completely custom and does not correspond to the amount of collectibles. For the general
@@ -36,8 +36,8 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: Col
  * Use this helper function instead of invoking the `EntityPlayer.CheckFamiliar` method directly so
  * that the target count is handled automatically.
  *
- * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
- * to `CacheFlag.FAMILIARS`).
+ * This function is meant to be called in the `EVALUATE_CACHE` callback (when the cache flag is
+ * equal to `CacheFlag.FAMILIARS`).
  *
  * Use this function when the amount of familiars should be equal to the amount of associated
  * collectibles that the player has (plus any extras from having used Box of Friends or Monster

package/dist/functions/familiars.lua

@@ -14,8 +14,8 @@ local getFamiliars = ____entitiesSpecific.getFamiliars
 -- specify an incorrect RNG object. (The vanilla method is bugged in that it does not increment the
 -- RNG object; see the documentation of the method for more details.)
 -- 
--- This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
--- to `CacheFlag.FAMILIARS`).
+-- This function is meant to be called in the `EVALUATE_CACHE` callback (when the cache flag is
+-- equal to `CacheFlag.FAMILIARS`).
 -- 
 -- Note that this function is only meant to be used in special circumstances where the familiar
 -- count is completely custom and does not correspond to the amount of collectibles. For the general
@@ -50,8 +50,8 @@ end
 -- Use this helper function instead of invoking the `EntityPlayer.CheckFamiliar` method directly so
 -- that the target count is handled automatically.
 -- 
--- This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
--- to `CacheFlag.FAMILIARS`).
+-- This function is meant to be called in the `EVALUATE_CACHE` callback (when the cache flag is
+-- equal to `CacheFlag.FAMILIARS`).
 -- 
 -- Use this function when the amount of familiars should be equal to the amount of associated
 -- collectibles that the player has (plus any extras from having used Box of Friends or Monster

package/dist/functions/flag.d.ts

@@ -29,7 +29,7 @@ export declare function addFlag<T extends BitFlag | BitFlag128>(flags: T | BitFl
  * Helper function for casting a flag enum value to a `BitFlags` object.
  *
  * This is useful because the compiler will prevent you from assigning a specific flag to a
- * `BitFlags` property. (It does this to ensure type safety, since `BitFlags` can represent a zero
+ * `BitFlags` field. (It does this to ensure type safety, since `BitFlags` can represent a zero
  * value or a composition of N flags.)
  *
  * For example:

package/dist/functions/flag.lua

@@ -35,7 +35,7 @@ end
 --- Helper function for casting a flag enum value to a `BitFlags` object.
 -- 
 -- This is useful because the compiler will prevent you from assigning a specific flag to a
--- `BitFlags` property. (It does this to ensure type safety, since `BitFlags` can represent a zero
+-- `BitFlags` field. (It does this to ensure type safety, since `BitFlags` can represent a zero
 -- value or a composition of N flags.)
 -- 
 -- For example:

package/dist/functions/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./ambush";
 export * from "./array";
 export * from "./benchmark";
+export * from "./bitSet128";
 export * from "./bitwise";
 export * from "./bombs";
 export * from "./bosses";
@@ -61,6 +62,7 @@ export * from "./playerDataStructures";
 export * from "./playerHealth";
 export * from "./playerIndex";
 export * from "./players";
+export * from "./playerStats";
 export * from "./pocketItems";
 export * from "./positionVelocity";
 export * from "./pressurePlate";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":"AAEA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,OAAO,CAAC;AACtB,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/dist/functions/index.lua

@@ -23,6 +23,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.bitSet128")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.bitwise")
     for ____exportKey, ____exportValue in pairs(____export) do
@@ -503,6 +511,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.playerStats")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.pocketItems")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/functions/jsonRoom.lua

@@ -52,7 +52,7 @@ function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
     local roomShapeString = jsonRoom["$"].shape
     local roomShapeNumber = tonumber(roomShapeString)
     if roomShapeNumber == nil then
-        error("Failed to parse the \"shape\" property of a JSON room: " .. roomShapeString)
+        error("Failed to parse the \"shape\" field of a JSON room: " .. roomShapeString)
     end
     local roomShape = roomShapeNumber
     local doorSlotFlags = DoorSlotFlagZero
@@ -60,7 +60,7 @@ function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
         do
             local existsString = door["$"].exists
             if existsString ~= "True" and existsString ~= "False" then
-                error("Failed to parse the \"exists\" property of a JSON room door: " .. existsString)
+                error("Failed to parse the \"exists\" field of a JSON room door: " .. existsString)
             end
             if existsString == "False" then
                 goto __continue4
@@ -68,12 +68,12 @@ function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
             local xString = door["$"].x
             local x = tonumber(xString)
             if x == nil then
-                error("Failed to parse the \"x\" property of a JSON room door: " .. xString)
+                error("Failed to parse the \"x\" field of a JSON room door: " .. xString)
             end
             local yString = door["$"].y
             local y = tonumber(yString)
             if y == nil then
-                error("Failed to parse the \"y\" property of a JSON room door: " .. yString)
+                error("Failed to parse the \"y\" field of a JSON room door: " .. yString)
             end
             local doorSlot = getRoomShapeDoorSlot(nil, roomShape, x, y)
             if doorSlot == nil then

package/dist/functions/kColor.d.ts

@@ -20,7 +20,7 @@ export declare function deserializeKColor(kColor: SerializedKColor): KColor;
  * @param alpha Optional. The alpha value to use. Default is 1.
  */
 export declare function getRandomKColor(seedOrRNG?: Seed | RNG, alpha?: number): KColor;
-/** Helper function to check if something is an instantiated KColor object. */
+/** Helper function to check if something is an instantiated `KColor` object. */
 export declare function isKColor(object: unknown): object is KColor;
 /**
  * Used to determine is the given table is a serialized `KColor` object created by the save data

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

@@ -1 +1 @@
-{"version":3,"file":"kColor.d.ts","sourceRoot":"","sources":["../../src/functions/kColor.ts"],"names":[],"mappings":";;;;AAOA,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC1C,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAmClE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,KAAK,SAAI,GACR,MAAM,CAQR;AAED,8EAA8E;AAC9E,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAQ5B;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE"}
+{"version":3,"file":"kColor.d.ts","sourceRoot":"","sources":["../../src/functions/kColor.ts"],"names":[],"mappings":";;;;AAOA,oBAAY,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC1C,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAmClE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,KAAK,SAAI,GACR,MAAM,CAQR;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAQ5B;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE"}

package/dist/functions/kColor.lua

@@ -17,12 +17,12 @@ local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
 local ____types = require("functions.types")
 local isTable = ____types.isTable
---- Helper function to check if something is an instantiated KColor object.
+--- Helper function to check if something is an instantiated `KColor` object.
 function ____exports.isKColor(self, object)
     return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
 end
-local KEYS = {"Red", "Green", "Blue", "Alpha"}
 OBJECT_NAME = "KColor"
+local KEYS = {"Red", "Green", "Blue", "Alpha"}
 --- Helper function to copy a `KColor` Isaac API class.
 function ____exports.copyKColor(self, kColor)
     if not ____exports.isKColor(nil, kColor) then

package/dist/functions/log.lua

@@ -369,7 +369,7 @@ end
 --- Helper function to enumerate all of the properties of a "userdata" object (i.e. an object from
 -- the Isaac API).
 function ____exports.logUserdata(userdata)
-    if isUserdata(nil, userdata) then
+    if not isUserdata(nil, userdata) then
         ____exports.log("Userdata: [not userdata]")
         return
     end

package/dist/functions/npcs.d.ts

@@ -24,8 +24,8 @@ export declare function isAliveExceptionNPC(npc: EntityNPC): boolean;
  * that is spawned when the boss does the multi-stomp attack.
  *
  * When this attack occurs, four extra copies of Daddy Long Legs will be spawned with the same
- * entity type, variant, and sub-type. The `Entity.Parent` property will be undefined in this case,
- * so the way to tell them apart is to check for a non-undefined `Entity.SpawnerEntity` property.
+ * entity type, variant, and sub-type. The `Entity.Parent` field will be undefined in this case, so
+ * the way to tell them apart is to check for a non-undefined `Entity.SpawnerEntity` field.
  */
 export declare function isDaddyLongLegsChildStompEntity(npc: EntityNPC): boolean;
 /**

package/dist/functions/npcs.lua

@@ -50,8 +50,8 @@ end
 -- that is spawned when the boss does the multi-stomp attack.
 -- 
 -- When this attack occurs, four extra copies of Daddy Long Legs will be spawned with the same
--- entity type, variant, and sub-type. The `Entity.Parent` property will be undefined in this case,
--- so the way to tell them apart is to check for a non-undefined `Entity.SpawnerEntity` property.
+-- entity type, variant, and sub-type. The `Entity.Parent` field will be undefined in this case, so
+-- the way to tell them apart is to check for a non-undefined `Entity.SpawnerEntity` field.
 function ____exports.isDaddyLongLegsChildStompEntity(self, npc)
     return npc.Type == EntityType.DADDY_LONG_LEGS and npc.SpawnerEntity ~= nil
 end

package/dist/functions/playerIndex.d.ts

@@ -78,7 +78,7 @@ export declare function getPlayers(performCharacterExclusions?: boolean): Entity
 export declare function getSubPlayerParent(subPlayer: EntitySubPlayer): EntityPlayer | undefined;
 /**
  * Helper function to detect if a particular player is a "child" player, meaning that they have a
- * non-undefined `EntityPlayer.Parent` property. (For example, the Strawman Keeper.)
+ * non-undefined `EntityPlayer.Parent` field. (For example, the Strawman Keeper.)
  */
 export declare function isChildPlayer(player: EntityPlayer): boolean;
 //# sourceMappingURL=playerIndex.d.ts.map

package/dist/functions/playerIndex.lua

@@ -125,7 +125,7 @@ function ____exports.getSubPlayerParent(self, subPlayer)
     )
 end
 --- Helper function to detect if a particular player is a "child" player, meaning that they have a
--- non-undefined `EntityPlayer.Parent` property. (For example, the Strawman Keeper.)
+-- non-undefined `EntityPlayer.Parent` field. (For example, the Strawman Keeper.)
 function ____exports.isChildPlayer(self, player)
     return player.Parent ~= nil
 end

package/dist/functions/playerStats.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="isaac-typescript-definitions" />
+import { StatType } from "../enums/StatType";
+import { StatTypeType } from "../interfaces/StatTypeType";
+/** Helper function to get the stat for a player corresponding to the `StatType`. */
+export declare function getPlayerStat<T extends StatType>(player: EntityPlayer, statType: T): StatTypeType[T];
+//# sourceMappingURL=playerStats.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playerStats.d.ts","sourceRoot":"","sources":["../../src/functions/playerStats.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,oFAAoF;AACpF,wBAAgB,aAAa,CAAC,CAAC,SAAS,QAAQ,EAC9C,MAAM,EAAE,YAAY,EACpB,QAAQ,EAAE,CAAC,GACV,YAAY,CAAC,CAAC,CAAC,CAiBjB"}

package/dist/functions/playerStats.lua

@@ -0,0 +1,21 @@
+local ____exports = {}
+local ____StatType = require("enums.StatType")
+local StatType = ____StatType.StatType
+--- Helper function to get the stat for a player corresponding to the `StatType`.
+function ____exports.getPlayerStat(self, player, statType)
+    return ({
+        [StatType.DAMAGE] = player.Damage,
+        [StatType.FIRE_DELAY] = player.MaxFireDelay,
+        [StatType.SHOT_SPEED] = player.ShotSpeed,
+        [StatType.TEAR_HEIGHT] = player.TearHeight,
+        [StatType.TEAR_RANGE] = player.TearRange,
+        [StatType.TEAR_FALLING_ACCELERATION] = player.TearFallingAcceleration,
+        [StatType.TEAR_FALLING_SPEED] = player.TearFallingSpeed,
+        [StatType.MOVE_SPEED] = player.MoveSpeed,
+        [StatType.TEAR_FLAG] = player.TearFlags,
+        [StatType.TEAR_COLOR] = player.TearColor,
+        [StatType.FLYING] = player.CanFly,
+        [StatType.LUCK] = player.Luck
+    })[statType]
+end
+return ____exports

package/dist/functions/players.d.ts

@@ -3,7 +3,7 @@ import { HealthType } from "../enums/HealthType";
 export declare function addCollectibleCostume(player: EntityPlayer, collectibleType: CollectibleType): void;
 /**
  * Helper function to add a stat to a player based on the `CacheFlag` provided. Call this function
- * from the EvaluateCache callback.
+ * from the `EVALUATE_CACHE` callback.
  *
  * Note that for `CacheFlag.FIRE_DELAY`, the "amount" argument will be interpreted as the tear stat
  * to add (and not the amount to mutate `EntityPlayer.MaxFireDelay` by).

package/dist/functions/players.lua

@@ -142,7 +142,7 @@ function ____exports.addCollectibleCostume(self, player, collectibleType)
     player:AddCostume(itemConfigItem, false)
 end
 --- Helper function to add a stat to a player based on the `CacheFlag` provided. Call this function
--- from the EvaluateCache callback.
+-- from the `EVALUATE_CACHE` callback.
 -- 
 -- Note that for `CacheFlag.FIRE_DELAY`, the "amount" argument will be interpreted as the tear stat
 -- to add (and not the amount to mutate `EntityPlayer.MaxFireDelay` by).

package/dist/functions/rng.d.ts

@@ -17,7 +17,7 @@ export declare function deserializeRNG(rng: SerializedRNG): RNG;
  * the game.
  */
 export declare function getRandomSeed(): Seed;
-/** Helper function to check if something is an instantiated RNG object. */
+/** Helper function to check if something is an instantiated `RNG` object. */
 export declare function isRNG(object: unknown): object is RNG;
 /**
  * Used to determine is the given table is a serialized `RNG` object created by the save data

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

@@ -1 +1 @@
-{"version":3,"file":"rng.d.ts","sourceRoot":"","sources":["../../src/functions/rng.ts"],"names":[],"mappings":";;;AAMA,oBAAY,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACpD,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC,CAAC;AAYF,wDAAwD;AACxD,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CASrC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,aAAa,GAAG,GAAG,CAatD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,2EAA2E;AAC3E,wBAAgB,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAEpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,OAAkB,GAAG,GAAG,CAIlD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAEvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,aAAa,CAYpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAoBjE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAK1D;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CASlD"}
+{"version":3,"file":"rng.d.ts","sourceRoot":"","sources":["../../src/functions/rng.ts"],"names":[],"mappings":";;;AAMA,oBAAY,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACpD,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC,CAAC;AAYF,wDAAwD;AACxD,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CASrC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,aAAa,GAAG,GAAG,CAatD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,6EAA6E;AAC7E,wBAAgB,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAEpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,OAAkB,GAAG,GAAG,CAIlD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAEvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,aAAa,CAYpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAoBjE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAK1D;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CASlD"}