isaacscript-common 31.9.0 → 31.10.1

package/dist/index.rollup.d.ts

@@ -8107,11 +8107,13 @@ declare type ISCFeatureTupleToClassTuple<T extends ISCFeature[]> = {
  */
 export declare function isCharacter(player: EntityPlayer, ...characters: PlayerType[]): boolean;
 
+/** Helper function to test if the provided pickup matches one of the various chest variants. */
+export declare function isChest(pickup: EntityPickup): boolean;
+
 /**
- * Helper function to test if the provided pickup or pickup variant matches one of the various chest
- * variants.
+ * Helper function to test if the provided pickup variant matches one of the various chest variants.
  */
-export declare function isChest(pickupOrPickupVariant: EntityPickup | PickupVariant): boolean;
+export declare function isChestVariant(pickupVariant: PickupVariant): boolean;
 
 /**
  * Helper function to detect if a particular player is a "child" player, meaning that they have a
@@ -8637,10 +8639,16 @@ export declare function isQuestCollectible(collectibleType: CollectibleType): bo
 export declare function isRaglingDeathPatch(npc: EntityNPC): boolean;
 
 /**
- * Helper function to test if the provided pickup matches one of the various red heart sub types.
+ * Helper function to test if the provided pickup matches one of the various red heart sub-types.
  */
 export declare function isRedHeart(pickup: EntityPickup): boolean;
 
+/**
+ * Helper function to test if the provided heart sub-type matches one of the various red heart
+ * sub-types.
+ */
+export declare function isRedHeartSubType(heartSubType: HeartSubType): boolean;
+
 /**
  * Helper function to detect if the provided room was created by the Red Key item. Under the hood,
  * this checks for the `RoomDescriptorFlag.FLAG_RED_ROOM` flag.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 31.9.0
+isaacscript-common 31.10.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -39718,8 +39718,9 @@ local ____pickupVariants = require("src.functions.pickupVariants")
 local isHeart = ____pickupVariants.isHeart
 local ____pickupsSpecific = require("src.functions.pickupsSpecific")
 local getHearts = ____pickupsSpecific.getHearts
-local ____types = require("src.functions.types")
-local isNumber = ____types.isNumber
+function ____exports.isChestVariant(self, pickupVariant)
+    return CHEST_PICKUP_VARIANTS:has(pickupVariant)
+end
 function ____exports.getCoinValue(self, coinSubType)
     local value = COIN_SUB_TYPE_TO_VALUE[coinSubType]
     return value or DEFAULT_COIN_VALUE
@@ -39731,13 +39732,15 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
-function ____exports.isChest(self, pickupOrPickupVariant)
-    local pickupVariant = isNumber(nil, pickupOrPickupVariant) and pickupOrPickupVariant or pickupOrPickupVariant.Variant
-    return CHEST_PICKUP_VARIANTS:has(pickupVariant)
+function ____exports.isChest(self, pickup)
+    return ____exports.isChestVariant(nil, pickup.Variant)
 end
 function ____exports.isRedHeart(self, pickup)
     return isHeart(nil, pickup) and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
 end
+function ____exports.isRedHeartSubType(self, heartSubType)
+    return RED_HEART_SUB_TYPES_SET:has(heartSubType)
+end
 function ____exports.removeAllRedHearts(self, cap)
     local redHearts = ____exports.getRedHearts(nil)
     return removeEntities(nil, redHearts, cap)
@@ -49012,6 +49015,7 @@ function getEntityLogLine(entity, num)
     msg = msg .. ("  - Child: " .. tostring(entity.Child)) .. "\n"
     msg = msg .. ("  - SpawnerEntity: " .. tostring(entity.SpawnerEntity)) .. "\n"
     msg = msg .. ((("  - SpawnerType / SpawnerVariant: " .. tostring(entity.SpawnerType)) .. ".") .. tostring(entity.SpawnerVariant)) .. "\n"
+    msg = msg .. ("  - FrameCount: " .. tostring(entity.FrameCount)) .. "\n"
     if npc ~= nil then
         msg = msg .. ("  - CanShutDoors: " .. tostring(npc.CanShutDoors)) .. "\n"
     end

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

@@ -1 +1 @@
-{"version":3,"file":"logEntities.d.ts","sourceRoot":"","sources":["../../../src/functions/logEntities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAIL,cAAc,EAOf,MAAM,8BAA8B,CAAC;AAkBtC,8FAA8F;AAC9F,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,wBAAwB,EAAE,OAAO,EACjC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,IAAI,CA2CN;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,YAAY,UAAQ,EACpB,oBAAoB,CAAC,EAAE,cAAc,GACpC,IAAI,CA+CN;AAED,iEAAiE;AACjE,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAIhE;AAED,kEAAkE;AAClE,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAG1D;AAmFD,sEAAsE;AACtE,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAI5E;AAED,wEAAwE;AACxE,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAGtE;AA+DD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAQ7D;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAInE"}
+{"version":3,"file":"logEntities.d.ts","sourceRoot":"","sources":["../../../src/functions/logEntities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAIL,cAAc,EAOf,MAAM,8BAA8B,CAAC;AAkBtC,8FAA8F;AAC9F,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,wBAAwB,EAAE,OAAO,EACjC,gBAAgB,CAAC,EAAE,UAAU,GAC5B,IAAI,CA2CN;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,IAAI,EACV,YAAY,UAAQ,EACpB,oBAAoB,CAAC,EAAE,cAAc,GACpC,IAAI,CA+CN;AAED,iEAAiE;AACjE,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAIhE;AAED,kEAAkE;AAClE,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAG1D;AAoFD,sEAAsE;AACtE,wBAAgB,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAI5E;AAED,wEAAwE;AACxE,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAGtE;AA+DD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAQ7D;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAInE"}

package/dist/src/functions/logEntities.lua

@@ -87,6 +87,7 @@ function getEntityLogLine(entity, num)
     msg = msg .. ("  - Child: " .. tostring(entity.Child)) .. "\n"
     msg = msg .. ("  - SpawnerEntity: " .. tostring(entity.SpawnerEntity)) .. "\n"
     msg = msg .. ((("  - SpawnerType / SpawnerVariant: " .. tostring(entity.SpawnerType)) .. ".") .. tostring(entity.SpawnerVariant)) .. "\n"
+    msg = msg .. ("  - FrameCount: " .. tostring(entity.FrameCount)) .. "\n"
     if npc ~= nil then
         msg = msg .. ("  - CanShutDoors: " .. tostring(npc.CanShutDoors)) .. "\n"
     end

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

@@ -1,4 +1,4 @@
-import type { CoinSubType, PickupVariant } from "isaac-typescript-definitions";
+import type { CoinSubType, HeartSubType, PickupVariant } from "isaac-typescript-definitions";
 /**
  * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
  * sub-types.
@@ -6,15 +6,21 @@ import type { CoinSubType, PickupVariant } from "isaac-typescript-definitions";
 export declare function getCoinValue(coinSubType: CoinSubType): int;
 /** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickupHeart[];
+/** Helper function to test if the provided pickup matches one of the various chest variants. */
+export declare function isChest(pickup: EntityPickup): boolean;
 /**
- * Helper function to test if the provided pickup or pickup variant matches one of the various chest
- * variants.
+ * Helper function to test if the provided pickup variant matches one of the various chest variants.
  */
-export declare function isChest(pickupOrPickupVariant: EntityPickup | PickupVariant): boolean;
+export declare function isChestVariant(pickupVariant: PickupVariant): boolean;
 /**
- * Helper function to test if the provided pickup matches one of the various red heart sub types.
+ * Helper function to test if the provided pickup matches one of the various red heart sub-types.
  */
 export declare function isRedHeart(pickup: EntityPickup): boolean;
+/**
+ * Helper function to test if the provided heart sub-type matches one of the various red heart
+ * sub-types.
+ */
+export declare function isRedHeartSubType(heartSubType: HeartSubType): boolean;
 /**
  * Helper function to remove all of the red heart pickup entities in the room.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"pickups.d.ts","sourceRoot":"","sources":["../../../src/functions/pickups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAY/E;;;GAGG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,GAAG,CAK1D;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,IAAI,iBAAiB,EAAE,CAGlD;AAED;;;GAGG;AACH,wBAAgB,OAAO,CACrB,qBAAqB,EAAE,YAAY,GAAG,aAAa,GAClD,OAAO,CAMT;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAExD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE,CAGjE"}
+{"version":3,"file":"pickups.d.ts","sourceRoot":"","sources":["../../../src/functions/pickups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,aAAa,EACd,MAAM,8BAA8B,CAAC;AAWtC;;;GAGG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,GAAG,CAK1D;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,IAAI,iBAAiB,EAAE,CAGlD;AAED,gGAAgG;AAChG,wBAAgB,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAErD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAEpE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAExD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE,CAGjE"}

package/dist/src/functions/pickups.lua

@@ -14,8 +14,10 @@ local ____pickupVariants = require("src.functions.pickupVariants")
 local isHeart = ____pickupVariants.isHeart
 local ____pickupsSpecific = require("src.functions.pickupsSpecific")
 local getHearts = ____pickupsSpecific.getHearts
-local ____types = require("src.functions.types")
-local isNumber = ____types.isNumber
+--- Helper function to test if the provided pickup variant matches one of the various chest variants.
+function ____exports.isChestVariant(self, pickupVariant)
+    return CHEST_PICKUP_VARIANTS:has(pickupVariant)
+end
 --- Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
 -- sub-types.
 function ____exports.getCoinValue(self, coinSubType)
@@ -30,16 +32,19 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
---- Helper function to test if the provided pickup or pickup variant matches one of the various chest
--- variants.
-function ____exports.isChest(self, pickupOrPickupVariant)
-    local pickupVariant = isNumber(nil, pickupOrPickupVariant) and pickupOrPickupVariant or pickupOrPickupVariant.Variant
-    return CHEST_PICKUP_VARIANTS:has(pickupVariant)
+--- Helper function to test if the provided pickup matches one of the various chest variants.
+function ____exports.isChest(self, pickup)
+    return ____exports.isChestVariant(nil, pickup.Variant)
 end
---- Helper function to test if the provided pickup matches one of the various red heart sub types.
+--- Helper function to test if the provided pickup matches one of the various red heart sub-types.
 function ____exports.isRedHeart(self, pickup)
     return isHeart(nil, pickup) and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
 end
+--- Helper function to test if the provided heart sub-type matches one of the various red heart
+-- sub-types.
+function ____exports.isRedHeartSubType(self, heartSubType)
+    return RED_HEART_SUB_TYPES_SET:has(heartSubType)
+end
 --- Helper function to remove all of the red heart pickup entities in the room.
 -- 
 -- @param cap Optional. If specified, will only remove the given amount of hearts.

package/package.json

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

package/src/functions/logEntities.ts

@@ -225,6 +225,7 @@ function getEntityLogLine(this: void, entity: Entity, num?: int): string {
   msg += `  - Child: ${entity.Child}\n`;
   msg += `  - SpawnerEntity: ${entity.SpawnerEntity}\n`;
   msg += `  - SpawnerType / SpawnerVariant: ${entity.SpawnerType}.${entity.SpawnerVariant}\n`;
+  msg += `  - FrameCount: ${entity.FrameCount}\n`;
   if (npc !== undefined) {
     msg += `  - CanShutDoors: ${npc.CanShutDoors}\n`;
   }

package/src/functions/pickups.ts

@@ -1,4 +1,8 @@
-import type { CoinSubType, PickupVariant } from "isaac-typescript-definitions";
+import type {
+  CoinSubType,
+  HeartSubType,
+  PickupVariant,
+} from "isaac-typescript-definitions";
 import {
   COIN_SUB_TYPE_TO_VALUE,
   DEFAULT_COIN_VALUE,
@@ -8,7 +12,6 @@ import { RED_HEART_SUB_TYPES_SET } from "../sets/redHeartSubTypesSet";
 import { removeEntities } from "./entities";
 import { isHeart } from "./pickupVariants";
 import { getHearts } from "./pickupsSpecific";
-import { isNumber } from "./types";
 
 /**
  * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
@@ -27,27 +30,33 @@ export function getRedHearts(): EntityPickupHeart[] {
   return hearts.filter((heart) => RED_HEART_SUB_TYPES_SET.has(heart.SubType));
 }
 
+/** Helper function to test if the provided pickup matches one of the various chest variants. */
+export function isChest(pickup: EntityPickup): boolean {
+  return isChestVariant(pickup.Variant);
+}
+
 /**
- * Helper function to test if the provided pickup or pickup variant matches one of the various chest
- * variants.
+ * Helper function to test if the provided pickup variant matches one of the various chest variants.
  */
-export function isChest(
-  pickupOrPickupVariant: EntityPickup | PickupVariant,
-): boolean {
-  const pickupVariant = isNumber(pickupOrPickupVariant)
-    ? pickupOrPickupVariant
-    : pickupOrPickupVariant.Variant;
-
+export function isChestVariant(pickupVariant: PickupVariant): boolean {
   return CHEST_PICKUP_VARIANTS.has(pickupVariant);
 }
 
 /**
- * Helper function to test if the provided pickup matches one of the various red heart sub types.
+ * Helper function to test if the provided pickup matches one of the various red heart sub-types.
  */
 export function isRedHeart(pickup: EntityPickup): boolean {
   return isHeart(pickup) && RED_HEART_SUB_TYPES_SET.has(pickup.SubType);
 }
 
+/**
+ * Helper function to test if the provided heart sub-type matches one of the various red heart
+ * sub-types.
+ */
+export function isRedHeartSubType(heartSubType: HeartSubType): boolean {
+  return RED_HEART_SUB_TYPES_SET.has(heartSubType);
+}
+
 /**
  * Helper function to remove all of the red heart pickup entities in the room.
  *