isaacscript-common 84.0.0 → 84.1.0

package/dist/functions/npcs.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRaglingDeathPatch = exports.isDyingEggyWithNoSpidersLeft = exports.isDyingDump = exports.isDaddyLongLegsChildStompEntity = exports.isAliveExceptionNPC = exports.getAliveNPCs = void 0;
+const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
+const constants_1 = require("../core/constants");
+const ReadonlySet_1 = require("../types/ReadonlySet");
+const entitiesSpecific_1 = require("./entitiesSpecific");
+/**
+ * Used to filter out certain NPCs when determining of an NPC is "alive" and/or should keep the
+ * doors open.
+ */
+const NON_ALIVE_NPCS_TYPE_VARIANT = new ReadonlySet_1.ReadonlySet([
+    `${isaac_typescript_definitions_1.EntityType.VIS}.${isaac_typescript_definitions_1.VisVariant.CHUBBER_PROJECTILE}`,
+    `${isaac_typescript_definitions_1.EntityType.DEATH}.${isaac_typescript_definitions_1.DeathVariant.DEATH_SCYTHE}`,
+    `${isaac_typescript_definitions_1.EntityType.PEEP}.${isaac_typescript_definitions_1.PeepVariant.PEEP_EYE}`,
+    `${isaac_typescript_definitions_1.EntityType.PEEP}.${isaac_typescript_definitions_1.PeepVariant.BLOAT_EYE}`,
+    `${isaac_typescript_definitions_1.EntityType.BEGOTTEN}.${isaac_typescript_definitions_1.BegottenVariant.BEGOTTEN_CHAIN}`,
+    `${isaac_typescript_definitions_1.EntityType.MAMA_GURDY}.${isaac_typescript_definitions_1.MamaGurdyVariant.LEFT_HAND}`,
+    `${isaac_typescript_definitions_1.EntityType.MAMA_GURDY}.${isaac_typescript_definitions_1.MamaGurdyVariant.RIGHT_HAND}`,
+    `${isaac_typescript_definitions_1.EntityType.BIG_HORN}.${isaac_typescript_definitions_1.BigHornVariant.SMALL_HOLE}`,
+    `${isaac_typescript_definitions_1.EntityType.BIG_HORN}.${isaac_typescript_definitions_1.BigHornVariant.BIG_HOLE}`,
+    `${isaac_typescript_definitions_1.EntityType.DARK_ESAU}.${isaac_typescript_definitions_1.DarkEsauVariant.DARK_ESAU}`,
+    `${isaac_typescript_definitions_1.EntityType.DARK_ESAU}.${isaac_typescript_definitions_1.DarkEsauVariant.PIT}`, // 866.1
+]);
+/**
+ * Used to filter out certain NPCs when determining of an NPC is "alive" and/or should keep the
+ * doors open.
+ */
+const NON_ALIVE_NPCS_TYPE_VARIANT_SUB_TYPE = new ReadonlySet_1.ReadonlySet([
+    `${isaac_typescript_definitions_1.EntityType.CHARGER}.${isaac_typescript_definitions_1.ChargerVariant.CHARGER}.${isaac_typescript_definitions_1.ChargerSubType.MY_SHADOW}`,
+    `${isaac_typescript_definitions_1.EntityType.MOTHER}.${isaac_typescript_definitions_1.MotherVariant.MOTHER_1}.${isaac_typescript_definitions_1.MotherSubType.PHASE_2}`, // 912
+]);
+/**
+ * Helper function to get all of the non-dead NPCs in the room.
+ *
+ * This function will not include NPCs on an internal blacklist, such as Death's scythes or Big Horn
+ * holes.
+ *
+ * @param entityType Optional. If specified, will only get the NPCs that match the type. Default is
+ *                   -1, which matches every type.
+ * @param variant Optional. If specified, will only get the NPCs that match the variant. Default is
+ *                -1, which matches every variant.
+ * @param subType Optional. If specified, will only get the NPCs that match the sub-type. Default is
+ *                -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
+ */
+function getAliveNPCs(entityType = -1, variant = -1, subType = -1, ignoreFriendly = false) {
+    const npcs = (0, entitiesSpecific_1.getNPCs)(entityType, variant, subType, ignoreFriendly);
+    return npcs.filter((npc) => !npc.IsDead() && !isAliveExceptionNPC(npc));
+}
+exports.getAliveNPCs = getAliveNPCs;
+/**
+ * Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should
+ * not actually keep the doors closed (like Death's scythes).
+ */
+function isAliveExceptionNPC(npc) {
+    const entityTypeVariant = `${npc.Type}.${npc.Variant}`;
+    if (NON_ALIVE_NPCS_TYPE_VARIANT.has(entityTypeVariant)) {
+        return true;
+    }
+    const entityTypeVariantSubType = `${npc.Type}.${npc.Variant}.${npc.SubType}`;
+    if (NON_ALIVE_NPCS_TYPE_VARIANT_SUB_TYPE.has(entityTypeVariantSubType)) {
+        return true;
+    }
+    // EntityType.HOPPER (29)
+    // HopperVariant.EGGY (2)
+    if (isDyingEggyWithNoSpidersLeft(npc)) {
+        return true;
+    }
+    // EntityType.DADDY_LONG_LEGS (101)
+    if (isDaddyLongLegsChildStompEntity(npc)) {
+        return true;
+    }
+    // EntityType.RAGLING (256)
+    if (isRaglingDeathPatch(npc)) {
+        return true;
+    }
+    // EntityType.DUMP (876)
+    if (isDyingDump(npc)) {
+        return true;
+    }
+    return false;
+}
+exports.isAliveExceptionNPC = isAliveExceptionNPC;
+/**
+ * Helper function to distinguish between a normal Daddy Long Legs / Triachnid and the child entity
+ * that is spawned when the boss does the multi-stomp attack.
+ *
+ * When this attack occurs, four extra copies of Daddy Long Legs will be spawned with the same
+ * entity type, variant, and sub-type. The `Entity.Parent` field will be undefined in this case, so
+ * the way to tell them apart is to check for a non-undefined `Entity.SpawnerEntity` field.
+ */
+function isDaddyLongLegsChildStompEntity(npc) {
+    return (npc.Type === isaac_typescript_definitions_1.EntityType.DADDY_LONG_LEGS && npc.SpawnerEntity !== undefined);
+}
+exports.isDaddyLongLegsChildStompEntity = isDaddyLongLegsChildStompEntity;
+/**
+ * Helper function to detect the custom death state of a Dump. When Dumps die, they go to
+ * `NPCState.SPECIAL`, spit out their head, and then slowly fade away while shooting a burst of
+ * tears.
+ */
+function isDyingDump(npc) {
+    return (npc.Type === isaac_typescript_definitions_1.EntityType.DUMP &&
+        npc.Variant === isaac_typescript_definitions_1.DumpVariant.DUMP &&
+        npc.State === isaac_typescript_definitions_1.NPCState.SPECIAL);
+}
+exports.isDyingDump = isDyingDump;
+/**
+ * Helper function to detect the custom death state of an Eggy. Eggies are never actually marked
+ * dead by the game. Instead, when Eggies take fatal damage, they go into NPCState.STATE_SUICIDE and
+ * spawn 14 Swarm Spiders while their StateFrame ticks upwards.
+ */
+function isDyingEggyWithNoSpidersLeft(npc) {
+    return (npc.Type === isaac_typescript_definitions_1.EntityType.HOPPER &&
+        npc.Variant === isaac_typescript_definitions_1.HopperVariant.EGGY &&
+        npc.State === isaac_typescript_definitions_1.NPCState.SUICIDE &&
+        npc.StateFrame >= constants_1.EGGY_STATE_FRAME_OF_FINAL_SPIDER);
+}
+exports.isDyingEggyWithNoSpidersLeft = isDyingEggyWithNoSpidersLeft;
+/**
+ * Helper function to detect the custom death state of a Rag Man Ragling. When Rag Man Raglings die,
+ * they turn into a patch on the ground and can be revived by Rag Man at a later time. This causes
+ * them to show up as an "alive" enemy, so they should usually be filtered out of lists of alive
+ * enemies.
+ */
+function isRaglingDeathPatch(npc) {
+    return (npc.Type === isaac_typescript_definitions_1.EntityType.RAGLING &&
+        npc.Variant === isaac_typescript_definitions_1.RaglingVariant.RAG_MANS_RAGLING &&
+        // They go to `STATE_SPECIAL` when they are patches on the ground.
+        npc.State === isaac_typescript_definitions_1.NPCState.SPECIAL);
+}
+exports.isRaglingDeathPatch = isRaglingDeathPatch;

package/dist/functions/pickupVariants.js

@@ -0,0 +1,63 @@
+"use strict";
+/* eslint-disable sort-exports/sort-exports */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTrinket = exports.isCardPickup = exports.isCollectible = exports.isBattery = exports.isPill = exports.isSack = exports.isPoopPickup = exports.isBombPickup = exports.isKey = exports.isCoin = exports.isHeart = void 0;
+const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
+/** For `PickupVariant.HEART` (10). */
+function isHeart(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.HEART);
+}
+exports.isHeart = isHeart;
+/** For `PickupVariant.COIN` (20). */
+function isCoin(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.COIN);
+}
+exports.isCoin = isCoin;
+/** For `PickupVariant.KEY` (30). */
+function isKey(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.KEY);
+}
+exports.isKey = isKey;
+/** For `PickupVariant.BOMB` (40). */
+function isBombPickup(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.BOMB);
+}
+exports.isBombPickup = isBombPickup;
+/** For `PickupVariant.POOP` (42). */
+function isPoopPickup(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.POOP);
+}
+exports.isPoopPickup = isPoopPickup;
+/** For `PickupVariant.SACK` (69). */
+function isSack(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.SACK);
+}
+exports.isSack = isSack;
+/** For `PickupVariant.PILL` (70). */
+function isPill(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.PILL);
+}
+exports.isPill = isPill;
+/** For `PickupVariant.LIL_BATTERY` (90). */
+function isBattery(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP &&
+        pickup.Variant === isaac_typescript_definitions_1.PickupVariant.LIL_BATTERY);
+}
+exports.isBattery = isBattery;
+/** For `PickupVariant.COLLECTIBLE` (100). */
+function isCollectible(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP &&
+        pickup.Variant === isaac_typescript_definitions_1.PickupVariant.COLLECTIBLE);
+}
+exports.isCollectible = isCollectible;
+/** For `PickupVariant.CARD` (300). */
+function isCardPickup(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP && pickup.Variant === isaac_typescript_definitions_1.PickupVariant.CARD);
+}
+exports.isCardPickup = isCardPickup;
+/** For `PickupVariant.TRINKET` (350). */
+function isTrinket(pickup) {
+    return (pickup.Type === isaac_typescript_definitions_1.EntityType.PICKUP &&
+        pickup.Variant === isaac_typescript_definitions_1.PickupVariant.TRINKET);
+}
+exports.isTrinket = isTrinket;

package/dist/functions/pickups.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeAllRedHearts = exports.isRedHeartSubType = exports.isRedHeart = exports.isChestVariant = exports.isChest = exports.getSackName = exports.getRedHearts = exports.getKeyName = exports.getHeartName = exports.getCoinValue = exports.getCoinName = exports.getChestName = exports.getBombName = exports.getBatteryName = void 0;
+const constants_1 = require("../core/constants");
+const batteryNames_1 = require("../objects/batteryNames");
+const bombNames_1 = require("../objects/bombNames");
+const chestNames_1 = require("../objects/chestNames");
+const coinNames_1 = require("../objects/coinNames");
+const coinSubTypeToValue_1 = require("../objects/coinSubTypeToValue");
+const heartNames_1 = require("../objects/heartNames");
+const keyNames_1 = require("../objects/keyNames");
+const sackNames_1 = require("../objects/sackNames");
+const redHeartSubTypesSet_1 = require("../sets/redHeartSubTypesSet");
+const entities_1 = require("./entities");
+const pickupVariants_1 = require("./pickupVariants");
+const pickupsSpecific_1 = require("./pickupsSpecific");
+/**
+ * Helper function to get the name of a battery, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided battery sub-type is not valid.
+ *
+ * This function only works for vanilla battery types.
+ *
+ * For example, `getBatteryName(BatterySubType.MICRO)` would return "Micro Battery".
+ */
+function getBatteryName(batterySubType) {
+    // Handle modded hearts.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return batteryNames_1.BATTERY_NAMES[batterySubType] ?? batteryNames_1.DEFAULT_BATTERY_NAME;
+}
+exports.getBatteryName = getBatteryName;
+/**
+ * Helper function to get the name of a bomb, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided bomb sub-type is not valid.
+ *
+ * This function only works for vanilla bomb types.
+ *
+ * For example, `getBombName(BombSubType.DOUBLE_PACK)` would return "Double Bomb".
+ */
+function getBombName(bombSubType) {
+    // Handle modded bombs.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return bombNames_1.BOMB_NAMES[bombSubType] ?? bombNames_1.DEFAULT_BOMB_NAME;
+}
+exports.getBombName = getBombName;
+/**
+ * Helper function to get the name of a chest, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the pickup variant was not a chest.
+ *
+ * This function only works for vanilla chest types.
+ *
+ * For example, `getChestName(PickupVariant.SPIKED_CHEST)` would return "Spiked Chest".
+ */
+function getChestName(pickupVariant) {
+    const chestNames = chestNames_1.CHEST_NAMES;
+    return chestNames[pickupVariant] ?? chestNames_1.DEFAULT_CHEST_NAME;
+}
+exports.getChestName = getChestName;
+/**
+ * Helper function to get the name of a coin, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided coin sub-type is not valid.
+ *
+ * This function only works for vanilla chest types.
+ *
+ * For example, `getCoinName(CoinSubType.DOUBLE_PACK)` would return "Double Penny".
+ */
+function getCoinName(coinSubType) {
+    // Handle modded coins.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return coinNames_1.COIN_NAMES[coinSubType] ?? coinNames_1.DEFAULT_COIN_NAME;
+}
+exports.getCoinName = getCoinName;
+/**
+ * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
+ * sub-types.
+ */
+function getCoinValue(coinSubType) {
+    const value = coinSubTypeToValue_1.COIN_SUB_TYPE_TO_VALUE[coinSubType];
+    // Handle modded coin sub-types.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return value ?? coinSubTypeToValue_1.DEFAULT_COIN_VALUE;
+}
+exports.getCoinValue = getCoinValue;
+/**
+ * Helper function to get the name of a heart, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided heart sub-type is not valid.
+ *
+ * This function only works for vanilla heart types.
+ *
+ * For example, `getHeartName(HeartSubType.ETERNAL)` would return "Heart (eternal)".
+ */
+function getHeartName(heartSubType) {
+    // Handle modded hearts.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return heartNames_1.HEART_NAMES[heartSubType] ?? heartNames_1.DEFAULT_HEART_NAME;
+}
+exports.getHeartName = getHeartName;
+/**
+ * Helper function to get the name of a key, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided key sub-type is not valid.
+ *
+ * This function only works for vanilla key types.
+ *
+ * For example, `getKeyName(KeySubType.DOUBLE_PACK)` would return "Key Ring".
+ */
+function getKeyName(keySubType) {
+    // Handle modded bombs.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return keyNames_1.KEY_NAMES[keySubType] ?? keyNames_1.DEFAULT_KEY_NAME;
+}
+exports.getKeyName = getKeyName;
+/** Helper function to get all of the red heart pickup entities in the room. */
+function getRedHearts() {
+    const hearts = (0, pickupsSpecific_1.getHearts)();
+    return hearts.filter((heart) => redHeartSubTypesSet_1.RED_HEART_SUB_TYPES_SET.has(heart.SubType));
+}
+exports.getRedHearts = getRedHearts;
+/**
+ * Helper function to get the name of a sack, as listed in the "entities2.xml" file. Returns
+ * "Unknown" if the provided sack sub-type is not valid.
+ *
+ * This function only works for vanilla sack types.
+ *
+ * For example, `getSackName(SackSubType.NORMAL)` would return "Grab Bag".
+ */
+function getSackName(sackSubType) {
+    // Handle modded hearts.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return sackNames_1.SACK_NAMES[sackSubType] ?? sackNames_1.DEFAULT_SACK_NAME;
+}
+exports.getSackName = getSackName;
+/** Helper function to test if the provided pickup matches one of the various chest variants. */
+function isChest(pickup) {
+    return isChestVariant(pickup.Variant);
+}
+exports.isChest = isChest;
+/**
+ * Helper function to test if the provided pickup variant matches one of the various chest variants.
+ */
+function isChestVariant(pickupVariant) {
+    return constants_1.CHEST_PICKUP_VARIANTS_SET.has(pickupVariant);
+}
+exports.isChestVariant = isChestVariant;
+/**
+ * Helper function to test if the provided pickup matches one of the various red heart sub-types.
+ */
+function isRedHeart(pickup) {
+    return (0, pickupVariants_1.isHeart)(pickup) && redHeartSubTypesSet_1.RED_HEART_SUB_TYPES_SET.has(pickup.SubType);
+}
+exports.isRedHeart = isRedHeart;
+/**
+ * Helper function to test if the provided heart sub-type matches one of the various red heart
+ * sub-types.
+ */
+function isRedHeartSubType(heartSubType) {
+    return redHeartSubTypesSet_1.RED_HEART_SUB_TYPES_SET.has(heartSubType);
+}
+exports.isRedHeartSubType = isRedHeartSubType;
+/**
+ * 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.
+ * @returns The red hearts that were removed.
+ */
+function removeAllRedHearts(cap) {
+    const redHearts = getRedHearts();
+    return (0, entities_1.removeEntities)(redHearts, cap);
+}
+exports.removeAllRedHearts = removeAllRedHearts;