isaacscript-common 21.1.1 → 21.2.0

package/dist/index.d.ts

@@ -7619,6 +7619,12 @@ export declare function isFirstSlotPocketActiveItem(player: EntityPlayer): boole
 
 export declare function isFlyingCharacter(player: EntityPlayer): boolean;
 
+/**
+ * Helper function to detect if a particular player is the Found Soul player provided by the
+ * trinket.
+ */
+export declare function isFoundSoul(player: EntityPlayer): boolean;
+
 export declare function isFunction(variable: unknown): variable is Function;
 
 /**
@@ -13838,9 +13844,6 @@ declare type SerializableSet<T> = Set<SerializableInsideArrayOrMap<T>>;
 /**
  * During serialization, we write an arbitrary string key to the object with a value of an empty
  * string. This is used during deserialization to instantiate the correct type of object.
- *
- * Note that we do not bother branding TSTL classes because we have no way to run the proper
- * constructor during deserialization.
  */
 export declare enum SerializationBrand {
     DEFAULT_MAP = "__TSTL_DEFAULT_MAP",
@@ -14324,9 +14327,7 @@ export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seedO
  */
 export declare function shuffleArrayInPlace<T>(array: T[], seedOrRNG?: Seed | RNG): void;
 
-/**
- * @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0.
- */
+/** @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0. */
 export declare function sign(n: number): int;
 
 declare class SlotDestroyedDetection extends Feature {

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 21.1.1
+isaacscript-common 21.2.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -13972,6 +13972,16 @@ ____exports.BloodExplosionSubType.GIANT = 4
 ____exports.BloodExplosionSubType[____exports.BloodExplosionSubType.GIANT] = "GIANT"
 ____exports.BloodExplosionSubType.SWIRL = 5
 ____exports.BloodExplosionSubType[____exports.BloodExplosionSubType.SWIRL] = "SWIRL"
+--- For `EntityType.EFFECT` (1000), `EffectVariant.BLOOD_PARTICLE` (5).
+____exports.GibSubType = {}
+____exports.GibSubType.BLOOD = 0
+____exports.GibSubType[____exports.GibSubType.BLOOD] = "BLOOD"
+____exports.GibSubType.BONE = 1
+____exports.GibSubType[____exports.GibSubType.BONE] = "BONE"
+____exports.GibSubType.GUT = 2
+____exports.GibSubType[____exports.GibSubType.GUT] = "GUT"
+____exports.GibSubType.EYE = 3
+____exports.GibSubType[____exports.GibSubType.EYE] = "EYE"
 --- For `EntityType.EFFECT` (1000), `EffectVariant.POOF_1` (15).
 ____exports.PoofSubType = {}
 ____exports.PoofSubType.NORMAL = 0
@@ -21488,8 +21498,10 @@ local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local ____exports = {}
 local getPlayerIndexCollectibleType, DEFAULT_COLLECTIBLE_TYPE, EXCLUDED_CHARACTERS
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local BabySubType = ____isaac_2Dtypescript_2Ddefinitions.BabySubType
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local PlayerVariant = ____isaac_2Dtypescript_2Ddefinitions.PlayerVariant
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
 local ____ReadonlySet = require("src.types.ReadonlySet")
@@ -21601,6 +21613,9 @@ function ____exports.getPlayerIndexVanilla(self, playerToFind)
     end
     return nil
 end
+function ____exports.isFoundSoul(self, player)
+    return ____exports.isChildPlayer(nil, player) and player.Variant == PlayerVariant.COOP_BABY and player.SubType == BabySubType.FOUND_SOUL
+end
 return ____exports
  end,
 ["src.functions.playerDataStructures"] = function(...) 
@@ -46711,21 +46726,21 @@ function ____exports.logAllGridEntities(includeWalls, gridEntityTypeFilter)
     msg = msg .. ":\n"
     local gridEntities = getGridEntities(nil)
     local numMatchedEntities = 0
-    __TS__ArrayForEach(
-        gridEntities,
-        function(____, gridEntity)
+    for ____, gridEntity in ipairs(gridEntities) do
+        do
             local gridEntityIndex = gridEntity:GetGridIndex()
             local gridEntityType = gridEntity:GetType()
             if gridEntityTypeFilter ~= nil and gridEntityType ~= gridEntityTypeFilter then
-                return
+                goto __continue15
             end
             if not includeWalls and gridEntityType == GridEntityType.WALL and gridEntityTypeFilter ~= GridEntityType.WALL then
-                return
+                goto __continue15
             end
             msg = msg .. getGridEntityLogLine(gridEntity, gridEntityIndex)
             numMatchedEntities = numMatchedEntities + 1
         end
-    )
+        ::__continue15::
+    end
     if numMatchedEntities == 0 then
         msg = msg .. "(no grid entities matched)\n"
     else

package/dist/src/enums/SerializationBrand.d.ts

@@ -1,9 +1,6 @@
 /**
  * During serialization, we write an arbitrary string key to the object with a value of an empty
  * string. This is used during deserialization to instantiate the correct type of object.
- *
- * Note that we do not bother branding TSTL classes because we have no way to run the proper
- * constructor during deserialization.
  */
 export declare enum SerializationBrand {
     DEFAULT_MAP = "__TSTL_DEFAULT_MAP",

package/dist/src/enums/SerializationBrand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SerializationBrand.d.ts","sourceRoot":"","sources":["../../../src/enums/SerializationBrand.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oBAAY,kBAAkB;IAE5B,WAAW,uBAAuB;IAClC,GAAG,eAAe;IAClB,GAAG,eAAe;IAGlB,WAAW,kBAAkB;IAC7B,KAAK,YAAY;IACjB,OAAO,cAAc;IACrB,GAAG,UAAU;IACb,MAAM,aAAa;IAEnB;;;OAGG;IACH,iBAAiB,6BAA6B;IAE9C;;;;;;;;;;OAUG;IACH,uBAAuB,mCAAmC;IAE1D;;;OAGG;IACH,UAAU,iBAAiB;CAC5B"}
+{"version":3,"file":"SerializationBrand.d.ts","sourceRoot":"","sources":["../../../src/enums/SerializationBrand.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,kBAAkB;IAE5B,WAAW,uBAAuB;IAClC,GAAG,eAAe;IAClB,GAAG,eAAe;IAGlB,WAAW,kBAAkB;IAC7B,KAAK,YAAY;IACjB,OAAO,cAAc;IACrB,GAAG,UAAU;IACb,MAAM,aAAa;IAEnB;;;OAGG;IACH,iBAAiB,6BAA6B;IAE9C;;;;;;;;;;OAUG;IACH,uBAAuB,mCAAmC;IAE1D;;;OAGG;IACH,UAAU,iBAAiB;CAC5B"}

package/dist/src/enums/SerializationBrand.lua

@@ -1,9 +1,6 @@
 local ____exports = {}
 --- During serialization, we write an arbitrary string key to the object with a value of an empty
 -- string. This is used during deserialization to instantiate the correct type of object.
--- 
--- Note that we do not bother branding TSTL classes because we have no way to run the proper
--- constructor during deserialization.
 ____exports.SerializationBrand = {}
 ____exports.SerializationBrand.DEFAULT_MAP = "__TSTL_DEFAULT_MAP"
 ____exports.SerializationBrand.MAP = "__TSTL_MAP"

package/dist/src/functions/logEntities.lua

@@ -207,21 +207,21 @@ function ____exports.logAllGridEntities(includeWalls, gridEntityTypeFilter)
     msg = msg .. ":\n"
     local gridEntities = getGridEntities(nil)
     local numMatchedEntities = 0
-    __TS__ArrayForEach(
-        gridEntities,
-        function(____, gridEntity)
+    for ____, gridEntity in ipairs(gridEntities) do
+        do
             local gridEntityIndex = gridEntity:GetGridIndex()
             local gridEntityType = gridEntity:GetType()
             if gridEntityTypeFilter ~= nil and gridEntityType ~= gridEntityTypeFilter then
-                return
+                goto __continue15
             end
             if not includeWalls and gridEntityType == GridEntityType.WALL and gridEntityTypeFilter ~= GridEntityType.WALL then
-                return
+                goto __continue15
             end
             msg = msg .. getGridEntityLogLine(gridEntity, gridEntityIndex)
             numMatchedEntities = numMatchedEntities + 1
         end
-    )
+        ::__continue15::
+    end
     if numMatchedEntities == 0 then
         msg = msg .. "(no grid entities matched)\n"
     else

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

@@ -43,9 +43,7 @@ export declare function lerpAngleDegrees(aStart: number, aEnd: number, percent:
  * @param numDecimalPlaces Optional. Default is 0.
  */
 export declare function round(num: float, numDecimalPlaces?: number): float;
-/**
- * @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0.
- */
+/** @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0. */
 export declare function sign(n: number): int;
 export declare function tanh(x: number): number;
 //# sourceMappingURL=math.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../../src/functions/math.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAGzD;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAErD;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,KAAK,CAGtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,GAAG,EACd,WAAW,SAAI,EACf,WAAW,SAAI,EACf,gBAAgB,YAAe,GAC9B,MAAM,EAAE,CAaV;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,GAClB,OAAO,CAOT;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,KAAK,EACnB,gBAAgB,EAAE,MAAM,EACxB,oBAAoB,EAAE,MAAM,GAC3B,OAAO,CAgBT;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGxC;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGvC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,MAAM,CAE7D;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,KAAK,GACb,MAAM,CAER;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,gBAAgB,SAAI,GAAG,KAAK,CAG7D;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAUnC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEtC"}
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../../src/functions/math.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAGzD;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAErD;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,KAAK,CAGtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,GAAG,EACd,WAAW,SAAI,EACf,WAAW,SAAI,EACf,gBAAgB,YAAe,GAC9B,MAAM,EAAE,CAaV;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,GAClB,OAAO,CAOT;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,KAAK,EACnB,gBAAgB,EAAE,MAAM,EACxB,oBAAoB,EAAE,MAAM,GAC3B,OAAO,CAgBT;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGxC;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGvC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,MAAM,CAE7D;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,KAAK,GACb,MAAM,CAER;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,gBAAgB,SAAI,GAAG,KAAK,CAG7D;AAED,wEAAwE;AACxE,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAUnC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEtC"}

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

@@ -81,4 +81,9 @@ export declare function getSubPlayerParent(subPlayer: EntitySubPlayer): EntityPl
  * non-undefined `EntityPlayer.Parent` field. (For example, the Strawman Keeper.)
  */
 export declare function isChildPlayer(player: EntityPlayer): boolean;
+/**
+ * Helper function to detect if a particular player is the Found Soul player provided by the
+ * trinket.
+ */
+export declare function isFoundSoul(player: EntityPlayer): boolean;
 //# sourceMappingURL=playerIndex.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"playerIndex.d.ts","sourceRoot":"","sources":["../../../src/functions/playerIndex.ts"],"names":[],"mappings":";;;AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAUnD;;;;;;GAMG;AACH,wBAAgB,aAAa,IAAI,YAAY,EAAE,CAU9C;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,EAAE,CAMpE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,GACvB,YAAY,GAAG,SAAS,CAG1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,6BAA6B,UAAQ,GACpC,WAAW,CA8Bb;AAiBD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,YAAY,GACzB,GAAG,GAAG,SAAS,CAajB;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,0BAA0B,UAAQ,GAAG,YAAY,EAAE,CAS7E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,eAAe,GACzB,YAAY,GAAG,SAAS,CAa1B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE3D"}
+{"version":3,"file":"playerIndex.d.ts","sourceRoot":"","sources":["../../../src/functions/playerIndex.ts"],"names":[],"mappings":";;;AAOA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAUnD;;;;;;GAMG;AACH,wBAAgB,aAAa,IAAI,YAAY,EAAE,CAU9C;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,YAAY,EAAE,CAMpE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,WAAW,GACvB,YAAY,GAAG,SAAS,CAG1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,6BAA6B,UAAQ,GACpC,WAAW,CA8Bb;AAiBD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,YAAY,GACzB,GAAG,GAAG,SAAS,CAajB;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,0BAA0B,UAAQ,GAAG,YAAY,EAAE,CAS7E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,eAAe,GACzB,YAAY,GAAG,SAAS,CAa1B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAE3D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAMzD"}

package/dist/src/functions/playerIndex.lua

@@ -5,8 +5,10 @@ local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local ____exports = {}
 local getPlayerIndexCollectibleType, DEFAULT_COLLECTIBLE_TYPE, EXCLUDED_CHARACTERS
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BabySubType = ____isaac_2Dtypescript_2Ddefinitions.BabySubType
 local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local PlayerVariant = ____isaac_2Dtypescript_2Ddefinitions.PlayerVariant
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
 local ____ReadonlySet = require("src.types.ReadonlySet")
@@ -173,4 +175,9 @@ function ____exports.getPlayerIndexVanilla(self, playerToFind)
     end
     return nil
 end
+--- Helper function to detect if a particular player is the Found Soul player provided by the
+-- trinket.
+function ____exports.isFoundSoul(self, player)
+    return ____exports.isChildPlayer(nil, player) and player.Variant == PlayerVariant.COOP_BABY and player.SubType == BabySubType.FOUND_SOUL
+end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "21.1.1",
+  "version": "21.2.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^11.0.3"
+    "isaac-typescript-definitions": "^11.1.0"
   }
 }

package/src/enums/SerializationBrand.ts

@@ -1,9 +1,6 @@
 /**
  * During serialization, we write an arbitrary string key to the object with a value of an empty
  * string. This is used during deserialization to instantiate the correct type of object.
- *
- * Note that we do not bother branding TSTL classes because we have no way to run the proper
- * constructor during deserialization.
  */
 export enum SerializationBrand {
   // Specific TSTL class brands.

package/src/functions/logEntities.ts

@@ -99,7 +99,7 @@ export function logAllGridEntities(
 
   const gridEntities = getGridEntities();
   let numMatchedEntities = 0;
-  gridEntities.forEach((gridEntity) => {
+  for (const gridEntity of gridEntities) {
     const gridEntityIndex = gridEntity.GetGridIndex();
     const gridEntityType = gridEntity.GetType();
 
@@ -108,7 +108,7 @@ export function logAllGridEntities(
       gridEntityTypeFilter !== undefined &&
       gridEntityType !== gridEntityTypeFilter
     ) {
-      return;
+      continue;
     }
 
     if (
@@ -116,13 +116,13 @@ export function logAllGridEntities(
       gridEntityType === GridEntityType.WALL &&
       gridEntityTypeFilter !== GridEntityType.WALL
     ) {
-      return;
+      continue;
     }
 
     msg += getGridEntityLogLine(gridEntity, gridEntityIndex);
 
     numMatchedEntities++;
-  });
+  }
 
   if (numMatchedEntities === 0) {
     msg += "(no grid entities matched)\n";

package/src/functions/math.ts

@@ -129,9 +129,7 @@ export function round(num: float, numDecimalPlaces = 0): float {
   return roundedNum === undefined ? 0 : roundedNum;
 }
 
-/**
- * @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0.
- */
+/** @returns 1 if n is positive, -1 if n is negative, or 0 if n is 0. */
 export function sign(n: number): int {
   if (n > 0) {
     return 1;

package/src/functions/playerIndex.ts

@@ -1,4 +1,9 @@
-import { CollectibleType, PlayerType } from "isaac-typescript-definitions";
+import {
+  BabySubType,
+  CollectibleType,
+  PlayerType,
+  PlayerVariant,
+} from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { PlayerIndex } from "../types/PlayerIndex";
 import { ReadonlySet } from "../types/ReadonlySet";
@@ -206,3 +211,15 @@ export function getSubPlayerParent(
 export function isChildPlayer(player: EntityPlayer): boolean {
   return player.Parent !== undefined;
 }
+
+/**
+ * Helper function to detect if a particular player is the Found Soul player provided by the
+ * trinket.
+ */
+export function isFoundSoul(player: EntityPlayer): boolean {
+  return (
+    isChildPlayer(player) &&
+    player.Variant === PlayerVariant.COOP_BABY &&
+    player.SubType === (BabySubType.FOUND_SOUL as int)
+  );
+}