isaacscript-common 10.2.1 → 11.0.0

package/dist/index.d.ts

@@ -4092,15 +4092,20 @@ export declare function getPlayerCollectiblesForCacheFlag(player: EntityPlayer,
 /** Helper function to get only the familiars that belong to a specific player. */
 export declare function getPlayerFamiliars(player: EntityPlayer): EntityFamiliar[];
 
+/**
+ * Helper function to get the player from a tear, laser, bomb, etc. Returns undefined if the entity
+ * does not correspond to any particular player.
+ *
+ * This function works by looking at the `Parent` and the `SpawnerEntity` fields (in that order).
+ */
+export declare function getPlayerFromEntity(entity: Entity): EntityPlayer | undefined;
+
 /**
  * Helper function to get the corresponding `EntityPlayer` object that corresponds to a
  * `PlayerIndex`.
  */
 export declare function getPlayerFromIndex(playerIndex: PlayerIndex): EntityPlayer | undefined;
 
-/** Helper function to get the player from a tear, laser, bomb, etc. */
-export declare function getPlayerFromTear(entity: Entity): EntityPlayer | undefined;
-
 /**
  * Helper function to get an object representing the player's health. You can use this in
  * combination with the `setPlayerHealth` function to restore the player's health back to a certain
@@ -6443,11 +6448,11 @@ export declare function isTear(variable: unknown): variable is EntityTear;
  * is determined by looking at the parent.
  *
  * For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
- * player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
- * and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
- * callback or on frame 2+.
+ * player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+ * onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+ * callback or on frame 1+.
  *
- * If this function is called on frame 0 or frame 1, it will throw a run-time error.
+ * If this function is called on frame 0, it will throw a run-time error.
  */
 export declare function isTearFromFamiliar(tear: EntityTear): boolean;
 
@@ -6456,11 +6461,11 @@ export declare function isTearFromFamiliar(tear: EntityTear): boolean;
  * is determined by looking at the parent.
  *
  * For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
- * player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
- * and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
- * callback or on frame 2+.
+ * player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+ * onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+ * callback or on frame 1+.
  *
- * If this function is called on frame 0 or frame 1, it will throw a run-time error.
+ * If this function is called on frame 0, it will throw a run-time error.
  */
 export declare function isTearFromPlayer(tear: EntityTear): boolean;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 10.2.1
+isaacscript-common 11.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -26300,8 +26300,11 @@ function ____exports.getPlayerCollectibleMap(self, player)
     end
     return collectibleMap
 end
---- Helper function to get the player from a tear, laser, bomb, etc.
-function ____exports.getPlayerFromTear(self, entity)
+--- Helper function to get the player from a tear, laser, bomb, etc. Returns undefined if the entity
+-- does not correspond to any particular player.
+-- 
+-- This function works by looking at the `Parent` and the `SpawnerEntity` fields (in that order).
+function ____exports.getPlayerFromEntity(self, entity)
     if entity.Parent ~= nil then
         local player = entity.Parent:ToPlayer()
         if player ~= nil then
@@ -26470,7 +26473,7 @@ function ____exports.isDamageFromPlayer(self, damageSource)
     if player ~= nil then
         return true
     end
-    local indirectPlayer = ____exports.getPlayerFromTear(nil, damageSource)
+    local indirectPlayer = ____exports.getPlayerFromEntity(nil, damageSource)
     return indirectPlayer ~= nil
 end
 --- Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where
@@ -39250,14 +39253,14 @@ end
 -- is determined by looking at the parent.
 -- 
 -- For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
--- player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
--- and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
--- callback or on frame 2+.
+-- player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+-- onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+-- callback or on frame 1+.
 -- 
--- If this function is called on frame 0 or frame 1, it will throw a run-time error.
+-- If this function is called on frame 0, it will throw a run-time error.
 function ____exports.isTearFromFamiliar(self, tear)
-    if tear.FrameCount == 0 or tear.FrameCount == 1 then
-        error(("Failed to check if the given tear was from a player since the tear's frame count was equal to " .. tostring(tear.FrameCount)) .. ". (The \"isTearFromFamiliar\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 2 and onwards.)")
+    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
     if tear.Parent == nil then
         return false
@@ -39269,14 +39272,14 @@ end
 -- is determined by looking at the parent.
 -- 
 -- For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
--- player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
--- and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
--- callback or on frame 2+.
+-- player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+-- onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+-- callback or on frame 1+.
 -- 
--- If this function is called on frame 0 or frame 1, it will throw a run-time error.
+-- If this function is called on frame 0, it will throw a run-time error.
 function ____exports.isTearFromPlayer(self, tear)
-    if tear.FrameCount == 0 or tear.FrameCount == 1 then
-        error(("Failed to check if the given tear was from a player since the tear's frame count was equal to " .. tostring(tear.FrameCount)) .. ". (The \"isTearFromPlayer\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 2 and onwards.)")
+    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 \"isTearFromPlayer\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 1 and onwards.)")
     end
     if tear.Parent == nil then
         return false
@@ -46947,7 +46950,7 @@ return ____exports
 ["package"] = function(...) 
 return {
     name = "isaacscript-common",
-    version = "10.2.1",
+    version = "11.0.0",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",

package/dist/package.lua

@@ -1,6 +1,6 @@
 return {
     name = "isaacscript-common",
-    version = "10.2.1",
+    version = "11.0.0",
     description = "Helper functions and features for IsaacScript mods.",
     keywords = {"isaac", "rebirth", "afterbirth", "repentance"},
     homepage = "https://isaacscript.github.io/",

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

@@ -73,8 +73,13 @@ export declare function getPlayerCollectibleCount(player: EntityPlayer, ...colle
  * Note that this will filter out non-real collectibles like Lilith's Incubus.
  */
 export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<CollectibleType, int>;
-/** Helper function to get the player from a tear, laser, bomb, etc. */
-export declare function getPlayerFromTear(entity: Entity): EntityPlayer | undefined;
+/**
+ * Helper function to get the player from a tear, laser, bomb, etc. Returns undefined if the entity
+ * does not correspond to any particular player.
+ *
+ * This function works by looking at the `Parent` and the `SpawnerEntity` fields (in that order).
+ */
+export declare function getPlayerFromEntity(entity: Entity): EntityPlayer | undefined;
 /**
  * Helper function to get the proper name of the player. Use this instead of the
  * `EntityPlayer.GetName` method because it accounts for Blue Baby, Lazarus II, and Tainted

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

@@ -1 +1 @@
-{"version":3,"file":"players.d.ts","sourceRoot":"","sources":["../../../src/functions/players.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,eAAe,EACf,eAAe,EAGf,UAAU,EAEV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAetC,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,kBAAkB,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CASjE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,UAAU,GAAG,SAAS,CAMxB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,kBAAkB,EAAE,YAAY,GAAG,KAAK,GACvC,KAAK,CAMP;AAED,+FAA+F;AAC/F,wBAAgB,aAAa,IAAI,UAAU,EAAE,CAG5C;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,CAiB/D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,EAAE,CAatE;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,YAAY,CAS7C;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAe9C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,KAAK,GACd,YAAY,GAAG,SAAS,CAK1B;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,GAAG,CASL;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAc3B;AAED,uEAAuE;AACvE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CA0B1E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAO1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAQnE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,CAO5E;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,IAAI,YAAY,EAAE,CAKrD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,YAAY,EAAE,CAOhB;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,eAAe,GAC/B,YAAY,EAAE,CAGhB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,YAAY,EAAE,WAAW,EAAE,GAC7B,YAAY,EAAE,CAKhB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,eAAe,GAC/B,GAAG,CASL;AAED,6FAA6F;AAC7F,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG1D;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAiBnE;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,YAAY,EACpB,GAAG,UAAU,EAAE,UAAU,EAAE,GAC1B,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAQhE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIpD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE3D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAI3D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAItD;AAED,+EAA+E;AAC/E,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMpD;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE5D;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMvD;AAaD,8FAA8F;AAC9F,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAM9D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAIN;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAa/D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAalE;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,EAChC,UAAU,EAAE,UAAU,EACtB,MAAM,CAAC,EAAE,GAAG,EACZ,WAAW,UAAQ,GAClB,IAAI,CA6DN;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,EAChB,aAAa,UAAO,GACnB,IAAI,CAsBN;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAEN"}
+{"version":3,"file":"players.d.ts","sourceRoot":"","sources":["../../../src/functions/players.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAEV,eAAe,EACf,eAAe,EAGf,UAAU,EAEV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAetC,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,kBAAkB,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxE;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CASjE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,UAAU,GAAG,SAAS,CAMxB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,kBAAkB,EAAE,YAAY,GAAG,KAAK,GACvC,KAAK,CAMP;AAED,+FAA+F;AAC/F,wBAAgB,aAAa,IAAI,UAAU,EAAE,CAG5C;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,CAiB/D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,EAAE,CAatE;AAED;;;GAGG;AACH,wBAAgB,cAAc,IAAI,YAAY,CAS7C;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAe9C;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,KAAK,GACd,YAAY,GAAG,SAAS,CAK1B;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,GAAG,CASL;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAc3B;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CA0B5E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAO1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAQnE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,CAO5E;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,IAAI,YAAY,EAAE,CAKrD;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,YAAY,EAAE,CAOhB;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAC3C,eAAe,EAAE,eAAe,GAC/B,YAAY,EAAE,CAGhB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,YAAY,EAAE,WAAW,EAAE,GAC7B,YAAY,EAAE,CAKhB;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,eAAe,EAAE,eAAe,GAC/B,GAAG,CASL;AAED,6FAA6F;AAC7F,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG1D;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAiBnE;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,YAAY,EACpB,GAAG,UAAU,EAAE,UAAU,EAAE,GAC1B,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAQhE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAIpD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE3D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAI3D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAItD;AAED,+EAA+E;AAC/E,wBAAgB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMpD;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE5D;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMvD;AAaD,8FAA8F;AAC9F,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAM9D;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAG7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,IAAI,CAIN;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,GAAG,gBAAgB,EAAE,eAAe,EAAE,GACrC,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAa/D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAalE;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAON;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAIlE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,WAAW,GACvB,IAAI,CAON;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,EAChC,UAAU,EAAE,UAAU,EACtB,MAAM,CAAC,EAAE,GAAG,EACZ,WAAW,UAAQ,GAClB,IAAI,CA6DN;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,EAChB,aAAa,UAAO,GACnB,IAAI,CAsBN;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,eAAe,EAAE,eAAe,GAC/B,IAAI,CAEN"}

package/dist/src/functions/players.lua

@@ -244,8 +244,11 @@ function ____exports.getPlayerCollectibleMap(self, player)
     end
     return collectibleMap
 end
---- Helper function to get the player from a tear, laser, bomb, etc.
-function ____exports.getPlayerFromTear(self, entity)
+--- Helper function to get the player from a tear, laser, bomb, etc. Returns undefined if the entity
+-- does not correspond to any particular player.
+-- 
+-- This function works by looking at the `Parent` and the `SpawnerEntity` fields (in that order).
+function ____exports.getPlayerFromEntity(self, entity)
     if entity.Parent ~= nil then
         local player = entity.Parent:ToPlayer()
         if player ~= nil then
@@ -414,7 +417,7 @@ function ____exports.isDamageFromPlayer(self, damageSource)
     if player ~= nil then
         return true
     end
-    local indirectPlayer = ____exports.getPlayerFromTear(nil, damageSource)
+    local indirectPlayer = ____exports.getPlayerFromEntity(nil, damageSource)
     return indirectPlayer ~= nil
 end
 --- Helper function for detecting when a player is Eden or Tainted Eden. Useful for situations where

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

@@ -28,11 +28,11 @@ export declare function getTearsStat(fireDelay: float): float;
  * is determined by looking at the parent.
  *
  * For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
- * player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
- * and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
- * callback or on frame 2+.
+ * player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+ * onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+ * callback or on frame 1+.
  *
- * If this function is called on frame 0 or frame 1, it will throw a run-time error.
+ * If this function is called on frame 0, it will throw a run-time error.
  */
 export declare function isTearFromFamiliar(tear: EntityTear): boolean;
 /**
@@ -40,11 +40,11 @@ export declare function isTearFromFamiliar(tear: EntityTear): boolean;
  * is determined by looking at the parent.
  *
  * For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
- * player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
- * and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
- * callback or on frame 2+.
+ * player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+ * onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+ * callback or on frame 1+.
  *
- * If this function is called on frame 0 or frame 1, it will throw a run-time error.
+ * If this function is called on frame 0, it will throw a run-time error.
  */
 export declare function isTearFromPlayer(tear: EntityTear): boolean;
 //# sourceMappingURL=tears.d.ts.map

package/dist/src/functions/tears.lua

@@ -28,14 +28,14 @@ end
 -- is determined by looking at the parent.
 -- 
 -- For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
--- player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
--- and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
--- callback or on frame 2+.
+-- player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+-- onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+-- callback or on frame 1+.
 -- 
--- If this function is called on frame 0 or frame 1, it will throw a run-time error.
+-- If this function is called on frame 0, it will throw a run-time error.
 function ____exports.isTearFromFamiliar(self, tear)
-    if tear.FrameCount == 0 or tear.FrameCount == 1 then
-        error(("Failed to check if the given tear was from a player since the tear's frame count was equal to " .. tostring(tear.FrameCount)) .. ". (The \"isTearFromFamiliar\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 2 and onwards.)")
+    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
     if tear.Parent == nil then
         return false
@@ -47,14 +47,14 @@ end
 -- is determined by looking at the parent.
 -- 
 -- For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
--- player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
--- and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
--- callback or on frame 2+.
+-- player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+-- onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+-- callback or on frame 1+.
 -- 
--- If this function is called on frame 0 or frame 1, it will throw a run-time error.
+-- If this function is called on frame 0, it will throw a run-time error.
 function ____exports.isTearFromPlayer(self, tear)
-    if tear.FrameCount == 0 or tear.FrameCount == 1 then
-        error(("Failed to check if the given tear was from a player since the tear's frame count was equal to " .. tostring(tear.FrameCount)) .. ". (The \"isTearFromPlayer\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 2 and onwards.)")
+    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 \"isTearFromPlayer\" function must only be used in the \"POST_TEAR_INIT_VERY_LATE\" callback or on frame 1 and onwards.)")
     end
     if tear.Parent == nil then
         return false

package/package.json

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

package/src/functions/players.ts

@@ -264,8 +264,13 @@ export function getPlayerCollectibleMap(
   return collectibleMap;
 }
 
-/** Helper function to get the player from a tear, laser, bomb, etc. */
-export function getPlayerFromTear(entity: Entity): EntityPlayer | undefined {
+/**
+ * Helper function to get the player from a tear, laser, bomb, etc. Returns undefined if the entity
+ * does not correspond to any particular player.
+ *
+ * This function works by looking at the `Parent` and the `SpawnerEntity` fields (in that order).
+ */
+export function getPlayerFromEntity(entity: Entity): EntityPlayer | undefined {
   if (entity.Parent !== undefined) {
     const player = entity.Parent.ToPlayer();
     if (player !== undefined) {
@@ -498,7 +503,7 @@ export function isDamageFromPlayer(damageSource: Entity): boolean {
     return true;
   }
 
-  const indirectPlayer = getPlayerFromTear(damageSource);
+  const indirectPlayer = getPlayerFromEntity(damageSource);
   return indirectPlayer !== undefined;
 }
 

package/src/functions/tears.ts

@@ -37,16 +37,16 @@ export function getTearsStat(fireDelay: float): float {
  * is determined by looking at the parent.
  *
  * For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
- * player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
- * and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
- * callback or on frame 2+.
+ * player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+ * onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+ * callback or on frame 1+.
  *
- * If this function is called on frame 0 or frame 1, it will throw a run-time error.
+ * If this function is called on frame 0, it will throw a run-time error.
  */
 export function isTearFromFamiliar(tear: EntityTear): boolean {
-  if (tear.FrameCount === 0 || tear.FrameCount === 1) {
+  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 ${tear.FrameCount}. (The "isTearFromFamiliar" function must only be used in the "POST_TEAR_INIT_VERY_LATE" callback or on frame 2 and onwards.)`,
+      '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.)',
     );
   }
 
@@ -64,16 +64,16 @@ export function isTearFromFamiliar(tear: EntityTear): boolean {
  * is determined by looking at the parent.
  *
  * For the special case of Incubus and Blood Babies, the spawner entity of the tear is always the
- * player. The parent of the tear is the player on frames 0 and 1 and it is the familiar on frames 2
- * and onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
- * callback or on frame 2+.
+ * player. The parent of the tear is the player on frame 0 and it is the familiar on frame 1 and
+ * onwards. For this reason, you can only use this function in the `POST_TEAR_INIT_VERY_LATE`
+ * callback or on frame 1+.
  *
- * If this function is called on frame 0 or frame 1, it will throw a run-time error.
+ * If this function is called on frame 0, it will throw a run-time error.
  */
 export function isTearFromPlayer(tear: EntityTear): boolean {
-  if (tear.FrameCount === 0 || tear.FrameCount === 1) {
+  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 ${tear.FrameCount}. (The "isTearFromPlayer" function must only be used in the "POST_TEAR_INIT_VERY_LATE" callback or on frame 2 and onwards.)`,
+      'Failed to check if the given tear was from a player since the tear\'s frame count was equal to 0. (The "isTearFromPlayer" function must only be used in the "POST_TEAR_INIT_VERY_LATE" callback or on frame 1 and onwards.)',
     );
   }