isaacscript-common 9.11.1 → 9.12.0

package/dist/functions/array.d.ts

@@ -159,8 +159,6 @@ export declare function getRandomArrayElementAndRemove<T>(array: T[], seedOrRNG?
  *                   index. Default is an empty array.
  */
 export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOrRNG?: Seed | RNG, exceptions?: int[] | readonly int[]): int;
-/** Initializes an array with all elements containing the specified default value. */
-export declare function initArray<T>(defaultValue: T, size: int): T[];
 /**
  * Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a
  * particular table is being used as an array. `isArray` returns true if:

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

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/functions/array.ts"],"names":[],"mappings":";;;AAKA;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EAC1B,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GACzB,OAAO,CAST;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,CAAC,EAAE,CAIL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,CAAC,EAAE,CAIL;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,OAAO,CAcT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,OAAO,CAWT;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,GAAG,eAAe,EAAE,GAAG,EAAE,GACxB,CAAC,EAAE,CAWL;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,eAAe,EAAE,GAAG,EAAE,GACxB,OAAO,CAeT;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,MAAM,CAQlE;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAS1E;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,QAAQ,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EAC5B,WAAW,CAAC,EAAE,GAAG,GAChB,CAAC,EAAE,CAcL;AAED,0EAA0E;AAC1E,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAE9C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACzB,iBAAiB,EAAE,OAAO,EAC1B,GAAG,CAAC,EAAE,GAAG,EACT,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CA0C7B;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,GAAG,EAAE,CAEnE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,SAAS,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACzB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAO,GAClC,CAAC,CAiBH;AAED;;;;;;;;GAQG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAC9C,KAAK,EAAE,CAAC,EAAE,EACV,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAO,GAClC,CAAC,CAQH;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACzB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,GAAG,EAAE,GAAG,SAAS,GAAG,EAAO,GACtC,GAAG,CAQL;AAED,qFAAqF;AACrF,wBAAgB,SAAS,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,EAAE,CAO5D;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,OAAO,EAAE,CAkC5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAavD;AAED,iEAAiE;AACjE,wBAAgB,cAAc,CAAC,CAAC,EAC9B,YAAY,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EAChC,WAAW,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,GACrC,OAAO,CAET;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,CAAC,EAAE,CAKL;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,KAAK,EAAE,CAAC,EAAE,EACV,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,IAAI,CAWN;AAED,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAEpE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAM3E"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/functions/array.ts"],"names":[],"mappings":";;;AAKA;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EAC1B,MAAM,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GACzB,OAAO,CAST;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,CAAC,EAAE,CAIL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,CAAC,EAAE,CAIL;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,OAAO,CAcT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,CAAC,EAAE,GACvB,OAAO,CAWT;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,GAAG,eAAe,EAAE,GAAG,EAAE,GACxB,CAAC,EAAE,CAWL;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EACvC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,eAAe,EAAE,GAAG,EAAE,GACxB,OAAO,CAeT;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,MAAM,CAQlE;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAS1E;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,QAAQ,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EAC5B,WAAW,CAAC,EAAE,GAAG,GAChB,CAAC,EAAE,CAcL;AAED,0EAA0E;AAC1E,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,IAAI,CAE9C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACzB,iBAAiB,EAAE,OAAO,EAC1B,GAAG,CAAC,EAAE,GAAG,EACT,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CA0C7B;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,GAAG,GAAG,EAAE,CAEnE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,SAAS,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACzB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAO,GAClC,CAAC,CAiBH;AAED;;;;;;;;GAQG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAC9C,KAAK,EAAE,CAAC,EAAE,EACV,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAO,GAClC,CAAC,CAQH;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,KAAK,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACzB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,GAAG,EAAE,GAAG,SAAS,GAAG,EAAO,GACtC,GAAG,CAQL;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,OAAO,EAAE,CAkC5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,OAAO,CAavD;AAED,iEAAiE;AACjE,wBAAgB,cAAc,CAAC,CAAC,EAC9B,YAAY,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EAChC,WAAW,EAAE,KAAK,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,GACrC,OAAO,CAET;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,aAAa,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAE,EACjC,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,CAAC,EAAE,CAKL;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,KAAK,EAAE,CAAC,EAAE,EACV,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,IAAI,CAWN;AAED,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAEpE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAM3E"}

package/dist/functions/array.lua

@@ -26,7 +26,6 @@ local isNumber = ____types.isNumber
 local isTable = ____types.isTable
 local ____utils = require("functions.utils")
 local erange = ____utils.erange
-local ____repeat = ____utils["repeat"]
 --- Removes all of the specified element(s) from the array. If the specified element(s) are not found
 -- in the array, this function will do nothing.
 -- 
@@ -398,18 +397,6 @@ function ____exports.getRandomArrayElementAndRemove(self, array, seedOrRNG, exce
     ____exports.arrayRemoveInPlace(nil, array, randomArrayElement)
     return randomArrayElement
 end
---- Initializes an array with all elements containing the specified default value.
-function ____exports.initArray(self, defaultValue, size)
-    local array = {}
-    ____repeat(
-        nil,
-        size,
-        function()
-            array[#array + 1] = defaultValue
-        end
-    )
-    return array
-end
 --- Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a
 -- particular table is being used as an array. `isArray` returns true if:
 -- 

package/dist/functions/benchmark.d.ts

@@ -2,7 +2,12 @@
 /**
  * Helper function to benchmark the performance of a function.
  *
- * This function is variadic, which means that you can supply as many as you want to benchmark.
+ * This function is variadic, which means that you can supply as many functions as you want to
+ * benchmark.
+ *
+ * This function uses the `Isaac.GetTime` method to record how long the function took to execute.
+ * This method only reports time in milliseconds. For this reason, if you are benchmarking smaller
+ * functions, then you should provide a very high value for the number of trials.
  *
  * @returns An array containing the average time in milliseconds for each function. (This will also
  *          be printed to the log.)

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

@@ -1 +1 @@
-{"version":3,"file":"benchmark.d.ts","sourceRoot":"","sources":["../../src/functions/benchmark.ts"],"names":[],"mappings":";AAEA;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,SAAS,EAAE,GAAG,EACd,GAAG,SAAS,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,GAC9B,GAAG,EAAE,CAsBP"}
+{"version":3,"file":"benchmark.d.ts","sourceRoot":"","sources":["../../src/functions/benchmark.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CACvB,SAAS,EAAE,GAAG,EACd,GAAG,SAAS,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,GAC9B,GAAG,EAAE,CAsBP"}

package/dist/functions/benchmark.lua

@@ -5,7 +5,12 @@ local ____log = require("functions.log")
 local log = ____log.log
 --- Helper function to benchmark the performance of a function.
 -- 
--- This function is variadic, which means that you can supply as many as you want to benchmark.
+-- This function is variadic, which means that you can supply as many functions as you want to
+-- benchmark.
+-- 
+-- This function uses the `Isaac.GetTime` method to record how long the function took to execute.
+-- This method only reports time in milliseconds. For this reason, if you are benchmarking smaller
+-- functions, then you should provide a very high value for the number of trials.
 -- 
 -- @returns An array containing the average time in milliseconds for each function. (This will also
 -- be printed to the log.)

package/dist/functions/deepCopy.d.ts

@@ -3,10 +3,13 @@ import { SerializationType } from "../enums/SerializationType";
  * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
  * of the nested references remain.
  *
- * It supports the following object types:
+ * `deepCopy` is used by the IsaacScript save data manager to make a backup of your variables, so
+ * that it can restore them to the default values at the beginning of a new room, floor, or run.
+ *
+ * `deepCopy` supports the following object types:
  *
  * - Primitives (i.e. strings, numbers, and booleans)
- * - Basic TSTL objects / tables
+ * - Basic TSTL objects (which are the same thing as Lua tables)
  * - TSTL `Map`
  * - TSTL `Set`
  * - TSTL classes

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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,EACd,iBAAiB,oBAAyB,EAC1C,oBAAoB,SAAK,EACzB,SAAS,UAAQ,GAChB,OAAO,CAkDT"}

package/dist/functions/deepCopy.lua

@@ -49,10 +49,13 @@ local twoDimensionalSort = ____utils.twoDimensionalSort
 --- `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
 -- of the nested references remain.
 -- 
--- It supports the following object types:
+-- `deepCopy` is used by the IsaacScript save data manager to make a backup of your variables, so
+-- that it can restore them to the default values at the beginning of a new room, floor, or run.
+-- 
+-- `deepCopy` supports the following object types:
 -- 
 -- - Primitives (i.e. strings, numbers, and booleans)
--- - Basic TSTL objects / tables
+-- - Basic TSTL objects (which are the same thing as Lua tables)
 -- - TSTL `Map`
 -- - TSTL `Set`
 -- - TSTL classes

package/dist/functions/entities.d.ts

@@ -77,11 +77,10 @@ export declare function getEntityFields(entity: Entity): LuaMap<string, boolean
  * reference, you would use an `EntityPtr` instead of a `PtrHash`.
  */
 export declare function getEntityFromPtrHash(ptrHash: PtrHash): Entity | undefined;
-/** Helper function to return a string containing the entity's type, variant, and sub-type. */
+/** Helper function to get a string containing the entity's type, variant, and sub-type. */
 export declare function getEntityID(entity: Entity): string;
 /**
- * Helper function to return a formatted string in the format returned by the `getEntityID`
- * function.
+ * Helper function to get a formatted string in the format returned by the `getEntityID` function.
  */
 export declare function getEntityIDFromConstituents(entityType: EntityType, variant: int, subType: int): string;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAO/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAGzE;AAED,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAO/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAGzE;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}

package/dist/functions/entities.lua

@@ -219,12 +219,11 @@ function ____exports.getEntityFromPtrHash(self, ptrHash)
         function(____, entity) return GetPtrHash(entity) == ptrHash end
     )
 end
---- Helper function to return a string containing the entity's type, variant, and sub-type.
+--- Helper function to get a string containing the entity's type, variant, and sub-type.
 function ____exports.getEntityID(self, entity)
     return (((tostring(entity.Type) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType)
 end
---- Helper function to return a formatted string in the format returned by the `getEntityID`
--- function.
+--- Helper function to get a formatted string in the format returned by the `getEntityID` function.
 function ____exports.getEntityIDFromConstituents(self, entityType, variant, subType)
     return (((tostring(entityType) .. ".") .. tostring(variant)) .. ".") .. tostring(subType)
 end

package/dist/functions/gridEntities.d.ts

@@ -60,10 +60,10 @@ export declare function getGridEntitiesExcept(...gridEntityTypes: GridEntityType
  * arguments to match specific grid entity types.
  */
 export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[]): Map<int, GridEntity>;
-/** Helper function to return a string containing the grid entity's type and variant. */
+/** Helper function to get a string containing the grid entity's type and variant. */
 export declare function getGridEntityID(gridEntity: GridEntity): string;
 /**
- * Helper function to return a formatted string in the format returned by the `getGridEntityID`
+ * Helper function to get a formatted string in the format returned by the `getGridEntityID`
  * function.
  */
 export declare function getGridEntityIDFromConstituents(gridEntityType: GridEntityType, variant: int): string;

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

@@ -1 +1 @@
-{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,cAAc,EACd,iBAAiB,EAIlB,MAAM,8BAA8B,CAAC;AAStC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAgCvD;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAqBnC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;GAMG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CA4BV;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,wFAAwF;AACxF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAI9D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CA2Bd;AAED,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAS7C;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAKpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,IAAI,CA4B1D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}
+{"version":3,"file":"gridEntities.d.ts","sourceRoot":"","sources":["../../src/functions/gridEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,cAAc,EACd,iBAAiB,EAIlB,MAAM,8BAA8B,CAAC;AAStC,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAgCvD;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,iBAAiB,EAAE,iBAAiB,EACpC,oBAAoB,EAAE,GAAG,GACxB,CAAC,cAAc,EAAE,GAAG,CAAC,GAAG,SAAS,CAqBnC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,EAAE,CAKzC;AAED;;;;;;GAMG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,UAAU,GACrB,MAAM,EAAE,CA4BV;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAgBD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAYd;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,CAUtB;AAED,qFAAqF;AACrF,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAI9D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,GACX,UAAU,EAAE,CAKd;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,UAAU,GACrB,UAAU,EAAE,CA2Bd;AAED,wBAAgB,cAAc,IAAI,UAAU,GAAG,SAAS,CAIvD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,IAAI,GAAG,CAS7C;AAED;;;;;;GAMG;AACH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,UAAU,GACrB,OAAO,CAWT;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAKpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,eAAe,EAAE,cAAc,EAAE,GACnC,UAAU,EAAE,CAiBd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,cAAc,EAAE,cAAc,EAAE,GAClC,UAAU,EAAE,CAYd;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,aAAa,EACxD,YAAY,EAAE,CAAC,EAAE,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAoBL;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAC9B,qBAAqB,EAAE,UAAU,GAAG,GAAG,EACvC,UAAU,EAAE,OAAO,GAClB,IAAI,CAqCN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAGnE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,EAAE,GAAG,GAAG,IAAI,CA4B1D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,cAAc,EAAE,cAAc,EAC9B,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAExB;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,GAAG,GAAG,MAAM,GAChC,UAAU,GAAG,SAAS,CAgCxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAkBtE"}

package/dist/functions/gridEntities.lua

@@ -265,13 +265,13 @@ function ____exports.getGridEntitiesMap(self, ...)
     end
     return gridEntityMap
 end
---- Helper function to return a string containing the grid entity's type and variant.
+--- Helper function to get a string containing the grid entity's type and variant.
 function ____exports.getGridEntityID(self, gridEntity)
     local gridEntityType = gridEntity:GetType()
     local variant = gridEntity:GetVariant()
     return (tostring(gridEntityType) .. ".") .. tostring(variant)
 end
---- Helper function to return a formatted string in the format returned by the `getGridEntityID`
+--- Helper function to get a formatted string in the format returned by the `getGridEntityID`
 -- function.
 function ____exports.getGridEntityIDFromConstituents(self, gridEntityType, variant)
     return (tostring(gridEntityType) .. ".") .. tostring(variant)

package/dist/functions/initArray.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Initializes an array with all of the elements containing the specified default value.
+ *
+ * If the provided default value is not a boolean, number, or string, then it will be copied with
+ * the `deepCopy` function before adding it to the new array. In this way, you can initialize an
+ * array of arrays, or an array of maps, and so on. (If the `deepCopy` function was not used, then
+ * all of the array elements would just be references to the same underlying data structure.)
+ *
+ * For example:
+ *
+ * ```ts
+ * const arrayWithZeroes = initArray(0, 10); // Has 10 elements of 0.
+ * const arrayWithArrays = initArray([0], 20); // Has 20 elements of an array with a 0 in it.
+ * ```
+ */
+export declare function initArray<T>(defaultValue: T, size: int): T[];
+//# sourceMappingURL=initArray.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"initArray.d.ts","sourceRoot":"","sources":["../../src/functions/initArray.ts"],"names":[],"mappings":";AAIA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,EAAE,CAY5D"}

package/dist/functions/initArray.lua

@@ -0,0 +1,37 @@
+local ____exports = {}
+local ____deepCopy = require("functions.deepCopy")
+local deepCopy = ____deepCopy.deepCopy
+local ____types = require("functions.types")
+local isPrimitive = ____types.isPrimitive
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+--- Initializes an array with all of the elements containing the specified default value.
+-- 
+-- If the provided default value is not a boolean, number, or string, then it will be copied with
+-- the `deepCopy` function before adding it to the new array. In this way, you can initialize an
+-- array of arrays, or an array of maps, and so on. (If the `deepCopy` function was not used, then
+-- all of the array elements would just be references to the same underlying data structure.)
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const arrayWithZeroes = initArray(0, 10); // Has 10 elements of 0.
+-- const arrayWithArrays = initArray([0], 20); // Has 20 elements of an array with a 0 in it.
+-- ```
+function ____exports.initArray(self, defaultValue, size)
+    local array = {}
+    ____repeat(
+        nil,
+        size,
+        function()
+            if isPrimitive(nil, defaultValue) then
+                array[#array + 1] = defaultValue
+            else
+                local copy = deepCopy(nil, defaultValue)
+                array[#array + 1] = copy
+            end
+        end
+    )
+    return array
+end
+return ____exports

package/dist/functions/input.d.ts

@@ -1,5 +1,8 @@
 import { ButtonAction, Controller, Keyboard } from "isaac-typescript-definitions";
-/** Helper function to get the enum name for the specified `Controller` value. */
+/**
+ * Helper function to get the enum name for the specified `Controller` value. Note that this will
+ * trim off the "BUTTON_" prefix.
+ */
 export declare function controllerToString(controller: Controller): string | undefined;
 export declare function getMoveActions(): ReadonlySet<ButtonAction>;
 export declare function getShootActions(): ReadonlySet<ButtonAction>;
@@ -31,6 +34,11 @@ export declare function isShootActionPressedOnAnyInput(): boolean;
 export declare function isShootActionTriggeredOnAnyInput(): boolean;
 /**
  * Helper function to get the string that would be typed if someone pressed the corresponding key.
+ * This is useful for creating in-game chat.
+ *
+ * Note that this function will only work for the keyboard values that are printable. Thus, it will
+ * return undefined for e.g. `Keyboard.LEFT_SHIFT` (340). If all you want is the corresponding name
+ * of the key, then simply use the enum reverse mapping (e.g. `Keyboard[keyboard]`).
  */
 export declare function keyboardToString(keyboard: Keyboard, uppercase: boolean): string | undefined;
 //# sourceMappingURL=input.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/functions/input.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EAEV,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAsCtC,iFAAiF;AACjF,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAO7E;AAED,wBAAgB,cAAc,IAAI,WAAW,CAAC,YAAY,CAAC,CAE1D;AAED,wBAAgB,eAAe,IAAI,WAAW,CAAC,YAAY,CAAC,CAE3D;AAED,gGAAgG;AAChG,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAK7E;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,YAAY,GACzB,OAAO,CAKT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAI9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C;AAED,wBAAgB,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEhE;AAED,wBAAgB,6BAA6B,IAAI,OAAO,CAIvD;AAED,wBAAgB,+BAA+B,IAAI,OAAO,CAIzD;AAED,wBAAgB,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEjE;AAED,wBAAgB,8BAA8B,IAAI,OAAO,CAIxD;AAED,wBAAgB,gCAAgC,IAAI,OAAO,CAI1D;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,OAAO,GACjB,MAAM,GAAG,SAAS,CAQpB"}
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/functions/input.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EAEV,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAsCtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAO7E;AAED,wBAAgB,cAAc,IAAI,WAAW,CAAC,YAAY,CAAC,CAE1D;AAED,wBAAgB,eAAe,IAAI,WAAW,CAAC,YAAY,CAAC,CAE3D;AAED,gGAAgG;AAChG,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAK7E;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,YAAY,GACzB,OAAO,CAKT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAI9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C;AAED,wBAAgB,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEhE;AAED,wBAAgB,6BAA6B,IAAI,OAAO,CAIvD;AAED,wBAAgB,+BAA+B,IAAI,OAAO,CAIzD;AAED,wBAAgB,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEjE;AAED,wBAAgB,8BAA8B,IAAI,OAAO,CAIxD;AAED,wBAAgB,gCAAgC,IAAI,OAAO,CAI1D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,OAAO,GACjB,MAAM,GAAG,SAAS,CAQpB"}

package/dist/functions/input.lua

@@ -28,7 +28,8 @@ local MOVEMENT_ACTIONS = {ButtonAction.LEFT, ButtonAction.RIGHT, ButtonAction.UP
 local MOVEMENT_ACTIONS_SET = __TS__New(Set, MOVEMENT_ACTIONS)
 local SHOOTING_ACTIONS = {ButtonAction.SHOOT_LEFT, ButtonAction.SHOOT_RIGHT, ButtonAction.SHOOT_UP, ButtonAction.SHOOT_DOWN}
 local SHOOTING_ACTIONS_SET = __TS__New(Set, SHOOTING_ACTIONS)
---- Helper function to get the enum name for the specified `Controller` value.
+--- Helper function to get the enum name for the specified `Controller` value. Note that this will
+-- trim off the "BUTTON_" prefix.
 function ____exports.controllerToString(self, controller)
     local key = Controller[controller]
     if key == nil then
@@ -110,6 +111,11 @@ function ____exports.isShootActionTriggeredOnAnyInput(self)
     )
 end
 --- Helper function to get the string that would be typed if someone pressed the corresponding key.
+-- This is useful for creating in-game chat.
+-- 
+-- Note that this function will only work for the keyboard values that are printable. Thus, it will
+-- return undefined for e.g. `Keyboard.LEFT_SHIFT` (340). If all you want is the corresponding name
+-- of the key, then simply use the enum reverse mapping (e.g. `Keyboard[keyboard]`).
 function ____exports.keyboardToString(self, keyboard, uppercase)
     local tuple = KEYBOARD_TO_STRING:get(keyboard)
     if tuple == nil then

package/dist/index.d.ts

@@ -542,7 +542,12 @@ export declare const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
 /**
  * Helper function to benchmark the performance of a function.
  *
- * This function is variadic, which means that you can supply as many as you want to benchmark.
+ * This function is variadic, which means that you can supply as many functions as you want to
+ * benchmark.
+ *
+ * This function uses the `Isaac.GetTime` method to record how long the function took to execute.
+ * This method only reports time in milliseconds. For this reason, if you are benchmarking smaller
+ * functions, then you should provide a very high value for the number of trials.
  *
  * @returns An array containing the average time in milliseconds for each function. (This will also
  *          be printed to the log.)
@@ -851,7 +856,10 @@ export declare function combineArrays<T>(...arrays: Array<T[] | readonly T[]>):
  */
 export declare function combineSets<T>(...sets: Array<Set<T> | ReadonlySet<T>>): Set<T>;
 
-/** Helper function to get the enum name for the specified `Controller` value. */
+/**
+ * Helper function to get the enum name for the specified `Controller` value. Note that this will
+ * trim off the "BUTTON_" prefix.
+ */
 export declare function controllerToString(controller: Controller): string | undefined;
 
 export declare type ConversionHeartSubType = HeartSubType.SOUL | HeartSubType.BLACK;
@@ -1477,10 +1485,13 @@ export declare interface CustomStageTSConfig {
  * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
  * of the nested references remain.
  *
- * It supports the following object types:
+ * `deepCopy` is used by the IsaacScript save data manager to make a backup of your variables, so
+ * that it can restore them to the default values at the beginning of a new room, floor, or run.
+ *
+ * `deepCopy` supports the following object types:
  *
  * - Primitives (i.e. strings, numbers, and booleans)
- * - Basic TSTL objects / tables
+ * - Basic TSTL objects (which are the same thing as Lua tables)
  * - TSTL `Map`
  * - TSTL `Set`
  * - TSTL classes
@@ -2990,12 +3001,11 @@ export declare function getEntityFields(entity: Entity): LuaMap<string, boolean
  */
 export declare function getEntityFromPtrHash(ptrHash: PtrHash): Entity | undefined;
 
-/** Helper function to return a string containing the entity's type, variant, and sub-type. */
+/** Helper function to get a string containing the entity's type, variant, and sub-type. */
 export declare function getEntityID(entity: Entity): string;
 
 /**
- * Helper function to return a formatted string in the format returned by the `getEntityID`
- * function.
+ * Helper function to get a formatted string in the format returned by the `getEntityID` function.
  */
 export declare function getEntityIDFromConstituents(entityType: EntityType, variant: int, subType: int): string;
 
@@ -3249,11 +3259,11 @@ export declare function getGridEntitiesExcept(...gridEntityTypes: GridEntityType
  */
 export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[]): Map<int, GridEntity>;
 
-/** Helper function to return a string containing the grid entity's type and variant. */
+/** Helper function to get a string containing the grid entity's type and variant. */
 export declare function getGridEntityID(gridEntity: GridEntity): string;
 
 /**
- * Helper function to return a formatted string in the format returned by the `getGridEntityID`
+ * Helper function to get a formatted string in the format returned by the `getGridEntityID`
  * function.
  */
 export declare function getGridEntityIDFromConstituents(gridEntityType: GridEntityType, variant: int): string;
@@ -5424,9 +5434,6 @@ export declare function inDoubleTrouble(): boolean;
 
 export declare function inGenesisRoom(): boolean;
 
-/** Initializes an array with all elements containing the specified default value. */
-export declare function initArray<T>(defaultValue: T, size: int): T[];
-
 /**
  * `isaacscript-common` provides custom doors that can be spawned where any wall segment is. If you
  * use this feature, you must first call this initialization function at the beginning of your mod.
@@ -6454,6 +6461,11 @@ export declare function kColorEquals(kColor1: KColor, kColor2: KColor): boolean;
 
 /**
  * Helper function to get the string that would be typed if someone pressed the corresponding key.
+ * This is useful for creating in-game chat.
+ *
+ * Note that this function will only work for the keyboard values that are printable. Thus, it will
+ * return undefined for e.g. `Keyboard.LEFT_SHIFT` (340). If all you want is the corresponding name
+ * of the key, then simply use the enum reverse mapping (e.g. `Keyboard[keyboard]`).
  */
 export declare function keyboardToString(keyboard: Keyboard, uppercase: boolean): string | undefined;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "9.11.1",
+  "version": "9.12.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/array.ts

@@ -1,7 +1,7 @@
 import { getRandomInt } from "./random";
 import { getRandomSeed, isRNG, newRNG } from "./rng";
 import { isNumber, isTable } from "./types";
-import { erange, repeat } from "./utils";
+import { erange } from "./utils";
 
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
@@ -399,16 +399,6 @@ export function getRandomArrayIndex<T>(
   return getRandomInt(0, array.length - 1, seedOrRNG, exceptions);
 }
 
-/** Initializes an array with all elements containing the specified default value. */
-export function initArray<T>(defaultValue: T, size: int): T[] {
-  const array: T[] = [];
-  repeat(size, () => {
-    array.push(defaultValue);
-  });
-
-  return array;
-}
-
 /**
  * Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a
  * particular table is being used as an array. `isArray` returns true if:

package/src/functions/benchmark.ts

@@ -3,7 +3,12 @@ import { log } from "./log";
 /**
  * Helper function to benchmark the performance of a function.
  *
- * This function is variadic, which means that you can supply as many as you want to benchmark.
+ * This function is variadic, which means that you can supply as many functions as you want to
+ * benchmark.
+ *
+ * This function uses the `Isaac.GetTime` method to record how long the function took to execute.
+ * This method only reports time in milliseconds. For this reason, if you are benchmarking smaller
+ * functions, then you should provide a very high value for the number of trials.
  *
  * @returns An array containing the average time in milliseconds for each function. (This will also
  *          be printed to the log.)

package/src/functions/deepCopy.ts

@@ -34,10 +34,13 @@ const COPYABLE_ISAAC_API_CLASS_TYPES_SET = new Set<string>(
  * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
  * of the nested references remain.
  *
- * It supports the following object types:
+ * `deepCopy` is used by the IsaacScript save data manager to make a backup of your variables, so
+ * that it can restore them to the default values at the beginning of a new room, floor, or run.
+ *
+ * `deepCopy` supports the following object types:
  *
  * - Primitives (i.e. strings, numbers, and booleans)
- * - Basic TSTL objects / tables
+ * - Basic TSTL objects (which are the same thing as Lua tables)
  * - TSTL `Map`
  * - TSTL `Set`
  * - TSTL classes

package/src/functions/entities.ts

@@ -204,14 +204,13 @@ export function getEntityFromPtrHash(ptrHash: PtrHash): Entity | undefined {
   return entities.find((entity) => GetPtrHash(entity) === ptrHash);
 }
 
-/** Helper function to return a string containing the entity's type, variant, and sub-type. */
+/** Helper function to get a string containing the entity's type, variant, and sub-type. */
 export function getEntityID(entity: Entity): string {
   return `${entity.Type}.${entity.Variant}.${entity.SubType}`;
 }
 
 /**
- * Helper function to return a formatted string in the format returned by the `getEntityID`
- * function.
+ * Helper function to get a formatted string in the format returned by the `getEntityID` function.
  */
 export function getEntityIDFromConstituents(
   entityType: EntityType,

package/src/functions/gridEntities.ts

@@ -226,7 +226,7 @@ export function getGridEntitiesMap(
   return gridEntityMap;
 }
 
-/** Helper function to return a string containing the grid entity's type and variant. */
+/** Helper function to get a string containing the grid entity's type and variant. */
 export function getGridEntityID(gridEntity: GridEntity): string {
   const gridEntityType = gridEntity.GetType();
   const variant = gridEntity.GetVariant();
@@ -234,7 +234,7 @@ export function getGridEntityID(gridEntity: GridEntity): string {
 }
 
 /**
- * Helper function to return a formatted string in the format returned by the `getGridEntityID`
+ * Helper function to get a formatted string in the format returned by the `getGridEntityID`
  * function.
  */
 export function getGridEntityIDFromConstituents(

package/src/functions/initArray.ts

@@ -0,0 +1,32 @@
+import { deepCopy } from "./deepCopy";
+import { isPrimitive } from "./types";
+import { repeat } from "./utils";
+
+/**
+ * Initializes an array with all of the elements containing the specified default value.
+ *
+ * If the provided default value is not a boolean, number, or string, then it will be copied with
+ * the `deepCopy` function before adding it to the new array. In this way, you can initialize an
+ * array of arrays, or an array of maps, and so on. (If the `deepCopy` function was not used, then
+ * all of the array elements would just be references to the same underlying data structure.)
+ *
+ * For example:
+ *
+ * ```ts
+ * const arrayWithZeroes = initArray(0, 10); // Has 10 elements of 0.
+ * const arrayWithArrays = initArray([0], 20); // Has 20 elements of an array with a 0 in it.
+ * ```
+ */
+export function initArray<T>(defaultValue: T, size: int): T[] {
+  const array: T[] = [];
+  repeat(size, () => {
+    if (isPrimitive(defaultValue)) {
+      array.push(defaultValue);
+    } else {
+      const copy = deepCopy(defaultValue) as T;
+      array.push(copy);
+    }
+  });
+
+  return array;
+}

package/src/functions/input.ts

@@ -41,7 +41,10 @@ const SHOOTING_ACTIONS_SET: ReadonlySet<ButtonAction> = new Set(
   SHOOTING_ACTIONS,
 );
 
-/** Helper function to get the enum name for the specified `Controller` value. */
+/**
+ * Helper function to get the enum name for the specified `Controller` value. Note that this will
+ * trim off the "BUTTON_" prefix.
+ */
 export function controllerToString(controller: Controller): string | undefined {
   const key = Controller[controller];
   if (key === undefined) {
@@ -135,6 +138,11 @@ export function isShootActionTriggeredOnAnyInput(): boolean {
 
 /**
  * Helper function to get the string that would be typed if someone pressed the corresponding key.
+ * This is useful for creating in-game chat.
+ *
+ * Note that this function will only work for the keyboard values that are printable. Thus, it will
+ * return undefined for e.g. `Keyboard.LEFT_SHIFT` (340). If all you want is the corresponding name
+ * of the key, then simply use the enum reverse mapping (e.g. `Keyboard[keyboard]`).
  */
 export function keyboardToString(
   keyboard: Keyboard,