isaacscript-common 20.12.0 → 20.12.2

package/dist/index.d.ts

@@ -787,7 +787,7 @@ export declare enum AmbushType {
 export declare function angleToDirection(angleDegrees: int): Direction;
 
 /** Helper type to represent any class. (This is the same type as any class constructor.) */
-export declare type AnyClass = new (...args: unknown[]) => unknown;
+export declare type AnyClass = new () => object;
 
 /**
  * A type union that matches `Entity`, `EntityBomb`, `EntityEffect`, and so on.
@@ -6948,6 +6948,9 @@ export declare function initArray<T>(defaultValue: T, size: int): T[];
  * Helper function to instantiate an array of mod features all at once. Use this function if your
  * mod uses the pattern of expressing mod features as `ModFeature` classes.
  *
+ * If your feature classes have `v` variables, then this function will successfully register them
+ * with the save data manager.
+ *
  * For example:
  *
  * ```ts
@@ -6962,7 +6965,9 @@ export declare function initArray<T>(defaultValue: T, size: int): T[];
  * @returns An array of the instantiated features in the same order that the constructors were
  *          passed in.
  */
-export declare function initModFeatures(mod: ModUpgraded, modFeatures: Array<typeof ModFeature>): ModFeature[];
+export declare function initModFeatures<T extends ReadonlyArray<typeof ModFeature>>(mod: ModUpgraded, modFeatures: T): {
+    [Key in keyof T]: InstanceType<T[Key]>;
+};
 
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
 export declare function inLRoom(): boolean;

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 20.12.0
+isaacscript-common 20.12.2
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -51033,7 +51033,8 @@ local ____exports = {}
 function ____exports.initModFeatures(self, mod, modFeatures)
     local instantiatedModFeatures = {}
     for ____, modFeature in ipairs(modFeatures) do
-        local instantiatedModFeature = __TS__New(modFeature, mod)
+        local instantiatedModFeature = __TS__New(modFeature, mod, false)
+        instantiatedModFeature:init()
         instantiatedModFeatures[#instantiatedModFeatures + 1] = instantiatedModFeature
     end
     return instantiatedModFeatures

package/dist/src/functions/modFeatures.d.ts

@@ -4,6 +4,9 @@ import { ModUpgraded } from "../types/ModUpgraded";
  * Helper function to instantiate an array of mod features all at once. Use this function if your
  * mod uses the pattern of expressing mod features as `ModFeature` classes.
  *
+ * If your feature classes have `v` variables, then this function will successfully register them
+ * with the save data manager.
+ *
  * For example:
  *
  * ```ts
@@ -18,5 +21,7 @@ import { ModUpgraded } from "../types/ModUpgraded";
  * @returns An array of the instantiated features in the same order that the constructors were
  *          passed in.
  */
-export declare function initModFeatures(mod: ModUpgraded, modFeatures: Array<typeof ModFeature>): ModFeature[];
+export declare function initModFeatures<T extends ReadonlyArray<typeof ModFeature>>(mod: ModUpgraded, modFeatures: T): {
+    [Key in keyof T]: InstanceType<T[Key]>;
+};
 //# sourceMappingURL=modFeatures.d.ts.map

package/dist/src/functions/modFeatures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"modFeatures.d.ts","sourceRoot":"","sources":["../../../src/functions/modFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,WAAW,EAChB,WAAW,EAAE,KAAK,CAAC,OAAO,UAAU,CAAC,GACpC,UAAU,EAAE,CAUd"}
+{"version":3,"file":"modFeatures.d.ts","sourceRoot":"","sources":["../../../src/functions/modFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,aAAa,CAAC,OAAO,UAAU,CAAC,EACxE,GAAG,EAAE,WAAW,EAChB,WAAW,EAAE,CAAC,GACb;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAAE,CAY5C"}

package/dist/src/functions/modFeatures.lua

@@ -4,6 +4,9 @@ local ____exports = {}
 --- Helper function to instantiate an array of mod features all at once. Use this function if your
 -- mod uses the pattern of expressing mod features as `ModFeature` classes.
 -- 
+-- If your feature classes have `v` variables, then this function will successfully register them
+-- with the save data manager.
+-- 
 -- For example:
 -- 
 -- ```ts
@@ -20,7 +23,8 @@ local ____exports = {}
 function ____exports.initModFeatures(self, mod, modFeatures)
     local instantiatedModFeatures = {}
     for ____, modFeature in ipairs(modFeatures) do
-        local instantiatedModFeature = __TS__New(modFeature, mod)
+        local instantiatedModFeature = __TS__New(modFeature, mod, false)
+        instantiatedModFeature:init()
         instantiatedModFeatures[#instantiatedModFeatures + 1] = instantiatedModFeature
     end
     return instantiatedModFeatures

package/dist/src/types/AnyClass.d.ts

@@ -1,3 +1,3 @@
 /** Helper type to represent any class. (This is the same type as any class constructor.) */
-export type AnyClass = new (...args: unknown[]) => unknown;
+export type AnyClass = new () => object;
 //# sourceMappingURL=AnyClass.d.ts.map

package/dist/src/types/AnyClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnyClass.d.ts","sourceRoot":"","sources":["../../../src/types/AnyClass.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC"}
+{"version":3,"file":"AnyClass.d.ts","sourceRoot":"","sources":["../../../src/types/AnyClass.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,MAAM,MAAM,QAAQ,GAAG,UAAU,MAAM,CAAC"}

package/package.json

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

package/src/functions/modFeatures.ts

@@ -5,6 +5,9 @@ import { ModUpgraded } from "../types/ModUpgraded";
  * Helper function to instantiate an array of mod features all at once. Use this function if your
  * mod uses the pattern of expressing mod features as `ModFeature` classes.
  *
+ * If your feature classes have `v` variables, then this function will successfully register them
+ * with the save data manager.
+ *
  * For example:
  *
  * ```ts
@@ -19,17 +22,19 @@ import { ModUpgraded } from "../types/ModUpgraded";
  * @returns An array of the instantiated features in the same order that the constructors were
  *          passed in.
  */
-export function initModFeatures(
+export function initModFeatures<T extends ReadonlyArray<typeof ModFeature>>(
   mod: ModUpgraded,
-  modFeatures: Array<typeof ModFeature>,
-): ModFeature[] {
+  modFeatures: T,
+): { [Key in keyof T]: InstanceType<T[Key]> } {
   const instantiatedModFeatures: ModFeature[] = [];
 
   for (const modFeature of modFeatures) {
     // eslint-disable-next-line new-cap
-    const instantiatedModFeature = new modFeature(mod);
+    const instantiatedModFeature = new modFeature(mod, false);
+    instantiatedModFeature.init();
+
     instantiatedModFeatures.push(instantiatedModFeature);
   }
 
-  return instantiatedModFeatures;
+  return instantiatedModFeatures as { [Key in keyof T]: InstanceType<T[Key]> };
 }

package/src/types/AnyClass.ts

@@ -1,2 +1,2 @@
 /** Helper type to represent any class. (This is the same type as any class constructor.) */
-export type AnyClass = new (...args: unknown[]) => unknown;
+export type AnyClass = new () => object;