isaacscript-common 20.14.5 → 20.15.0

package/dist/index.d.ts

@@ -8025,8 +8025,14 @@ export declare function isTear(variable: unknown): variable is EntityTear;
  *
  * Note that this function does not work properly when the tear is from a Lead Pencil barrage. In
  * this case, it will always appear as if the tear is coming from a player.
+ *
+ * @param tear The tear to inspect.
+ * @param familiarVariant Optional. Specify this to check if the tear came from a specific familiar
+ *                        variant. Default is undefined, which checks for any familiar.
+ * @param subType Optional. Specify this to check if the tear came from a specific familiar
+ *                sub-type. Default is undefined, which checks for any familiar.
  */
-export declare function isTearFromFamiliar(tear: EntityTear): boolean;
+export declare function isTearFromFamiliar(tear: EntityTear, familiarVariant?: FamiliarVariant, subType?: int): boolean;
 
 /**
  * Helper function to check if a given tear is from a player (as opposed to e.g. a familiar). This

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 20.14.5
+isaacscript-common 20.15.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -35007,7 +35007,7 @@ function ____exports.addTearsStat(self, player, tearsStat)
     local newMaxFireDelay = ____exports.getFireDelay(nil, newTearsStat)
     player.MaxFireDelay = newMaxFireDelay
 end
-function ____exports.isTearFromFamiliar(self, tear)
+function ____exports.isTearFromFamiliar(self, tear, familiarVariant, subType)
     if tear.FrameCount == 0 then
         error("Failed to check if the given tear was from a player since the tear's frame count was equal to 0. (The \"isTearFromFamiliar\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 1 and onwards.)")
     end
@@ -35015,7 +35015,10 @@ function ____exports.isTearFromFamiliar(self, tear)
         return false
     end
     local familiar = tear.SpawnerEntity:ToFamiliar()
-    return familiar ~= nil
+    if familiar == nil then
+        return false
+    end
+    return (familiarVariant == nil or familiarVariant == familiar.Variant) and (subType == nil or subType == familiar.SubType)
 end
 function ____exports.isTearFromPlayer(self, tear)
     if tear.FrameCount == 0 then

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

@@ -1,6 +1,4 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="isaac-typescript-definitions" />
+import { FamiliarVariant } from "isaac-typescript-definitions";
 /**
  * - Converts the specified amount of tears stat into the format of `EntityPlayer.MaxFireDelay` and
  *   adds it to the player.
@@ -46,8 +44,14 @@ export declare function getTearsStat(fireDelay: float): float;
  *
  * Note that this function does not work properly when the tear is from a Lead Pencil barrage. In
  * this case, it will always appear as if the tear is coming from a player.
+ *
+ * @param tear The tear to inspect.
+ * @param familiarVariant Optional. Specify this to check if the tear came from a specific familiar
+ *                        variant. Default is undefined, which checks for any familiar.
+ * @param subType Optional. Specify this to check if the tear came from a specific familiar
+ *                sub-type. Default is undefined, which checks for any familiar.
  */
-export declare function isTearFromFamiliar(tear: EntityTear): boolean;
+export declare function isTearFromFamiliar(tear: EntityTear, familiarVariant?: FamiliarVariant, subType?: int): boolean;
 /**
  * Helper function to check if a given tear is from a player (as opposed to e.g. a familiar). This
  * is determined by looking at the parent.

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

@@ -1 +1 @@
-{"version":3,"file":"tears.d.ts","sourceRoot":"","sources":["../../../src/functions/tears.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI,CAKzE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,KAAK,GAAG,KAAK,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,KAAK,GAAG,KAAK,CAEpD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAgB5D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAgB1D"}
+{"version":3,"file":"tears.d.ts","sourceRoot":"","sources":["../../../src/functions/tears.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI,CAKzE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,KAAK,GAAG,KAAK,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,KAAK,GAAG,KAAK,CAEpD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,UAAU,EAChB,eAAe,CAAC,EAAE,eAAe,EACjC,OAAO,CAAC,EAAE,GAAG,GACZ,OAAO,CAuBT;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAgB1D"}

package/dist/src/functions/tears.lua

@@ -46,7 +46,13 @@ end
 -- 
 -- Note that this function does not work properly when the tear is from a Lead Pencil barrage. In
 -- this case, it will always appear as if the tear is coming from a player.
-function ____exports.isTearFromFamiliar(self, tear)
+-- 
+-- @param tear The tear to inspect.
+-- @param familiarVariant Optional. Specify this to check if the tear came from a specific familiar
+-- variant. Default is undefined, which checks for any familiar.
+-- @param subType Optional. Specify this to check if the tear came from a specific familiar
+-- sub-type. Default is undefined, which checks for any familiar.
+function ____exports.isTearFromFamiliar(self, tear, familiarVariant, subType)
     if tear.FrameCount == 0 then
         error("Failed to check if the given tear was from a player since the tear's frame count was equal to 0. (The \"isTearFromFamiliar\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 1 and onwards.)")
     end
@@ -54,7 +60,10 @@ function ____exports.isTearFromFamiliar(self, tear)
         return false
     end
     local familiar = tear.SpawnerEntity:ToFamiliar()
-    return familiar ~= nil
+    if familiar == nil then
+        return false
+    end
+    return (familiarVariant == nil or familiarVariant == familiar.Variant) and (subType == nil or subType == familiar.SubType)
 end
 --- Helper function to check if a given tear is from a player (as opposed to e.g. a familiar). This
 -- is determined by looking at the parent.

package/package.json

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

package/src/functions/tears.ts

@@ -1,3 +1,5 @@
+import { FamiliarVariant } from "isaac-typescript-definitions";
+
 /**
  * - Converts the specified amount of tears stat into the format of `EntityPlayer.MaxFireDelay` and
  *   adds it to the player.
@@ -55,8 +57,18 @@ export function getTearsStat(fireDelay: float): float {
  *
  * Note that this function does not work properly when the tear is from a Lead Pencil barrage. In
  * this case, it will always appear as if the tear is coming from a player.
+ *
+ * @param tear The tear to inspect.
+ * @param familiarVariant Optional. Specify this to check if the tear came from a specific familiar
+ *                        variant. Default is undefined, which checks for any familiar.
+ * @param subType Optional. Specify this to check if the tear came from a specific familiar
+ *                sub-type. Default is undefined, which checks for any familiar.
  */
-export function isTearFromFamiliar(tear: EntityTear): boolean {
+export function isTearFromFamiliar(
+  tear: EntityTear,
+  familiarVariant?: FamiliarVariant,
+  subType?: int,
+): boolean {
   if (tear.FrameCount === 0) {
     error(
       'Failed to check if the given tear was from a player since the tear\'s frame count was equal to 0. (The "isTearFromFamiliar" function must only be used in the "POST_TEAR_INIT_VERY_LATE" callback or on frame 1 and onwards.)',
@@ -71,7 +83,14 @@ export function isTearFromFamiliar(tear: EntityTear): boolean {
   // We cannot use `tear.SpawnerType` to determine this, since it is baked in to be equal to
   // `EntityType.PLAYER` regardless of whether the tear is from a player or familiar.
   const familiar = tear.SpawnerEntity.ToFamiliar();
-  return familiar !== undefined;
+  if (familiar === undefined) {
+    return false;
+  }
+
+  return (
+    (familiarVariant === undefined || familiarVariant === familiar.Variant) &&
+    (subType === undefined || subType === familiar.SubType)
+  );
 }
 
 /**