isaacscript-common 20.8.0 → 20.9.0

package/dist/index.d.ts

@@ -3299,6 +3299,19 @@ export declare function doesPlayerHaveAllBlackHearts(player: EntityPlayer): bool
  */
 export declare function doesPlayerHaveAllSoulHearts(player: EntityPlayer): boolean;
 
+/**
+ * Helper function to measure a vector to see if it has a non-zero length using a threshold to
+ * ignore extremely small values.
+ *
+ * Use this function instead of explicitly checking if the length is 0 because vectors in the game
+ * are unlikely to ever be exactly set to 0. Instead, they will always have some miniscule length.
+ *
+ * @param vector The vector to measure.
+ * @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
+ *                  0.01.
+ */
+export declare function doesVectorHaveAnyLength(vector: Vector, threshold?: number): boolean;
+
 export declare const DOGMA_ROOM_GRID_INDEX = 109;
 
 export declare const DOOR_HITBOX_RADIUS = 11;
@@ -6932,8 +6945,22 @@ 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.
+ *
+ * For example:
+ *
+ * ```ts
+ * const features = [
+ *   MyFeature1,
+ *   MyFeature2,
+ *   MyFeature3,
+ * ] as const;
+ * initModFeatures(mod, modFeatures);
+ * ```
+ *
+ * @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>): void;
+export declare function initModFeatures(mod: ModUpgraded, modFeatures: Array<typeof ModFeature>): ModFeature[];
 
 /** 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.8.0
+isaacscript-common 20.9.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -17401,6 +17401,12 @@ function ____exports.deserializeVector(self, vector)
     end
     return Vector(x, y)
 end
+function ____exports.doesVectorHaveAnyLength(self, vector, threshold)
+    if threshold == nil then
+        threshold = 0.01
+    end
+    return vector:Length() >= threshold
+end
 function ____exports.getRandomVector(self, seedOrRNG)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
@@ -19745,6 +19751,7 @@ local ____types = require("src.functions.types")
 local asNumber = ____types.asNumber
 local isPrimitive = ____types.isPrimitive
 local ____vector = require("src.functions.vector")
+local doesVectorHaveAnyLength = ____vector.doesVectorHaveAnyLength
 local isVector = ____vector.isVector
 local vectorToString = ____vector.vectorToString
 function setPrimitiveEntityFields(self, entity, metatable, entityFields)
@@ -19935,7 +19942,7 @@ function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01
     end
-    return entity.Velocity:Length() >= threshold
+    return doesVectorHaveAnyLength(nil, entity.Velocity, threshold)
 end
 function ____exports.isStoryBoss(self, entityType)
     return STORY_BOSSES_SET:has(entityType)
@@ -50910,9 +50917,12 @@ local ____lualib = require("lualib_bundle")
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 function ____exports.initModFeatures(self, mod, modFeatures)
+    local instantiatedModFeatures = {}
     for ____, modFeature in ipairs(modFeatures) do
-        __TS__New(modFeature, mod)
+        local instantiatedModFeature = __TS__New(modFeature, mod)
+        instantiatedModFeatures[#instantiatedModFeatures + 1] = instantiatedModFeature
     end
+    return instantiatedModFeatures
 end
 return ____exports
  end,

package/dist/src/functions/entities.lua

@@ -27,6 +27,7 @@ local ____types = require("src.functions.types")
 local asNumber = ____types.asNumber
 local isPrimitive = ____types.isPrimitive
 local ____vector = require("src.functions.vector")
+local doesVectorHaveAnyLength = ____vector.doesVectorHaveAnyLength
 local isVector = ____vector.isVector
 local vectorToString = ____vector.vectorToString
 function setPrimitiveEntityFields(self, entity, metatable, entityFields)
@@ -303,7 +304,7 @@ function ____exports.isEntityMoving(self, entity, threshold)
     if threshold == nil then
         threshold = 0.01
     end
-    return entity.Velocity:Length() >= threshold
+    return doesVectorHaveAnyLength(nil, entity.Velocity, threshold)
 end
 --- Helper function to determine if the specified entity type is an end-game story boss, like Isaac,
 -- Blue Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only

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

@@ -3,6 +3,20 @@ 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.
+ *
+ * For example:
+ *
+ * ```ts
+ * const features = [
+ *   MyFeature1,
+ *   MyFeature2,
+ *   MyFeature3,
+ * ] as const;
+ * initModFeatures(mod, modFeatures);
+ * ```
+ *
+ * @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>): void;
+export declare function initModFeatures(mod: ModUpgraded, modFeatures: Array<typeof ModFeature>): ModFeature[];
 //# 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;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,WAAW,EAChB,WAAW,EAAE,KAAK,CAAC,OAAO,UAAU,CAAC,GACpC,IAAI,CAKN"}
+{"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"}

package/dist/src/functions/modFeatures.lua

@@ -3,9 +3,26 @@ local __TS__New = ____lualib.__TS__New
 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.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const features = [
+--   MyFeature1,
+--   MyFeature2,
+--   MyFeature3,
+-- ] as const;
+-- initModFeatures(mod, modFeatures);
+-- ```
+-- 
+-- @returns An array of the instantiated features in the same order that the constructors were
+-- passed in.
 function ____exports.initModFeatures(self, mod, modFeatures)
+    local instantiatedModFeatures = {}
     for ____, modFeature in ipairs(modFeatures) do
-        __TS__New(modFeature, mod)
+        local instantiatedModFeature = __TS__New(modFeature, mod)
+        instantiatedModFeatures[#instantiatedModFeatures + 1] = instantiatedModFeature
     end
+    return instantiatedModFeatures
 end
 return ____exports

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

@@ -11,6 +11,18 @@ export declare function copyVector(vector: Vector): Vector;
  * the save data manager when reading data from the "save#.dat" file.)
  */
 export declare function deserializeVector(vector: SerializedVector): Vector;
+/**
+ * Helper function to measure a vector to see if it has a non-zero length using a threshold to
+ * ignore extremely small values.
+ *
+ * Use this function instead of explicitly checking if the length is 0 because vectors in the game
+ * are unlikely to ever be exactly set to 0. Instead, they will always have some miniscule length.
+ *
+ * @param vector The vector to measure.
+ * @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
+ *                  0.01.
+ */
+export declare function doesVectorHaveAnyLength(vector: Vector, threshold?: number): boolean;
 /**
  * Helper function to get a random vector between (-1, -1) and (1, 1).
  *

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

@@ -1 +1 @@
-{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,MAAM,CAOR;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AAatC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAqBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,MAAM,CAOR;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}

package/dist/src/functions/vector.lua

@@ -52,6 +52,21 @@ function ____exports.deserializeVector(self, vector)
     end
     return Vector(x, y)
 end
+--- Helper function to measure a vector to see if it has a non-zero length using a threshold to
+-- ignore extremely small values.
+-- 
+-- Use this function instead of explicitly checking if the length is 0 because vectors in the game
+-- are unlikely to ever be exactly set to 0. Instead, they will always have some miniscule length.
+-- 
+-- @param vector The vector to measure.
+-- @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
+-- 0.01.
+function ____exports.doesVectorHaveAnyLength(self, vector, threshold)
+    if threshold == nil then
+        threshold = 0.01
+    end
+    return vector:Length() >= threshold
+end
 --- Helper function to get a random vector between (-1, -1) and (1, 1).
 -- 
 -- To get random vectors with a bigger length, multiply this with a number.

package/package.json

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

package/src/functions/entities.ts

@@ -10,7 +10,7 @@ import { getRandom } from "./random";
 import { isRNG, newRNG } from "./rng";
 import { setSpriteOpacity } from "./sprites";
 import { asNumber, isPrimitive } from "./types";
-import { isVector, vectorToString } from "./vector";
+import { doesVectorHaveAnyLength, isVector, vectorToString } from "./vector";
 
 /** From DeadInfinity. */
 const DAMAGE_FLASH_COLOR: Readonly<Color> = Color(
@@ -316,7 +316,7 @@ export function hasArmor(entity: Entity): boolean {
  * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
  */
 export function isEntityMoving(entity: Entity, threshold = 0.01): boolean {
-  return entity.Velocity.Length() >= threshold;
+  return doesVectorHaveAnyLength(entity.Velocity, threshold);
 }
 
 /**

package/src/functions/modFeatures.ts

@@ -4,13 +4,32 @@ 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.
+ *
+ * For example:
+ *
+ * ```ts
+ * const features = [
+ *   MyFeature1,
+ *   MyFeature2,
+ *   MyFeature3,
+ * ] as const;
+ * initModFeatures(mod, modFeatures);
+ * ```
+ *
+ * @returns An array of the instantiated features in the same order that the constructors were
+ *          passed in.
  */
 export function initModFeatures(
   mod: ModUpgraded,
   modFeatures: Array<typeof ModFeature>,
-): void {
+): ModFeature[] {
+  const instantiatedModFeatures: ModFeature[] = [];
+
   for (const modFeature of modFeatures) {
-    // eslint-disable-next-line no-new, new-cap
-    new modFeature(mod);
+    // eslint-disable-next-line new-cap
+    const instantiatedModFeature = new modFeature(mod);
+    instantiatedModFeatures.push(instantiatedModFeature);
   }
+
+  return instantiatedModFeatures;
 }

package/src/functions/vector.ts

@@ -60,6 +60,24 @@ export function deserializeVector(vector: SerializedVector): Vector {
   return Vector(x, y);
 }
 
+/**
+ * Helper function to measure a vector to see if it has a non-zero length using a threshold to
+ * ignore extremely small values.
+ *
+ * Use this function instead of explicitly checking if the length is 0 because vectors in the game
+ * are unlikely to ever be exactly set to 0. Instead, they will always have some miniscule length.
+ *
+ * @param vector The vector to measure.
+ * @param threshold Optional. The threshold from 0 to consider to be a non-zero vector. Default is
+ *                  0.01.
+ */
+export function doesVectorHaveAnyLength(
+  vector: Vector,
+  threshold = 0.01,
+): boolean {
+  return vector.Length() >= threshold;
+}
+
 /**
  * Helper function to get a random vector between (-1, -1) and (1, 1).
  *