isaacscript-common 84.0.1 → 84.1.1

package/dist/functions/pickupsSpecific.js

@@ -0,0 +1,376 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spawnTrinketWithSeed = exports.spawnTrinket = exports.spawnSackWithSeed = exports.spawnSack = exports.spawnPillWithSeed = exports.spawnPill = exports.spawnKeyWithSeed = exports.spawnKey = exports.spawnHeartWithSeed = exports.spawnHeart = exports.spawnCoinWithSeed = exports.spawnCoin = exports.spawnCardWithSeed = exports.spawnCard = exports.spawnBombPickupWithSeed = exports.spawnBombPickup = exports.spawnBatteryWithSeed = exports.spawnBattery = exports.removeAllTrinkets = exports.removeAllSacks = exports.removeAllPills = exports.removeAllKeys = exports.removeAllHearts = exports.removeAllCollectibles = exports.removeAllCoins = exports.removeAllChests = exports.removeAllCards = exports.removeAllBombPickups = exports.removeAllBatteries = exports.getTrinkets = exports.getSacks = exports.getPills = exports.getKeys = exports.getHearts = exports.getCollectibles = exports.getCoins = exports.getChests = exports.getCards = exports.getBombPickups = exports.getBatteries = void 0;
+const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
+const constants_1 = require("../core/constants");
+const entities_1 = require("./entities");
+const entitiesSpecific_1 = require("./entitiesSpecific");
+/**
+ * Helper function to get all of the battery entities in the room.
+ *
+ * @param batterySubType Optional. If specified, will only get the batteries that match the
+ *                       sub-type. Default is -1, which matches every sub-type.
+ */
+function getBatteries(batterySubType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.LIL_BATTERY, batterySubType);
+}
+exports.getBatteries = getBatteries;
+/**
+ * Helper function to get all of the bomb entities in the room. (Specifically, this refers to bomb
+ * pickups, not the `EntityBomb` class.)
+ *
+ * @param bombSubType Optional. If specified, will only get the bombs that match the sub-type.
+ *                    Default is -1, which matches every sub-type.
+ */
+function getBombPickups(bombSubType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.BOMB, bombSubType);
+}
+exports.getBombPickups = getBombPickups;
+/**
+ * Helper function to get all of the card entities in the room.
+ *
+ * @param cardType Optional. If specified, will only get the cards that match the sub-type. Default
+ *                 is -1, which matches every sub-type.
+ */
+function getCards(cardType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.CARD, cardType);
+}
+exports.getCards = getCards;
+/**
+ * Helper function to get all of the chest entities in the room. Specifically, this is all of the
+ * pickups with a variant in the `CHEST_PICKUP_VARIANTS` constant.
+ *
+ * @param subType Optional. If specified, will only get the chests that match the sub-type. Default
+ *                is -1, which matches every sub-type.
+ */
+function getChests(subType = -1) {
+    const chests = [];
+    for (const pickupVariant of constants_1.CHEST_PICKUP_VARIANTS) {
+        const pickups = (0, entitiesSpecific_1.getPickups)(pickupVariant, subType);
+        chests.push(...pickups);
+    }
+    return chests;
+}
+exports.getChests = getChests;
+/**
+ * Helper function to get all of the coin pickup entities in the room.
+ *
+ * @param coinSubType Optional. If specified, will only get the coins that match the sub-type.
+ *                    Default is -1, which matches every sub-type.
+ */
+function getCoins(coinSubType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.COIN, coinSubType);
+}
+exports.getCoins = getCoins;
+/**
+ * Helper function to get all of the collectible entities in the room.
+ *
+ * @param collectibleType Optional. If specified, will only get the collectibles that match the
+ *                        sub-type. Default is -1, which matches every sub-type.
+ */
+function getCollectibles(collectibleType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.COLLECTIBLE, collectibleType);
+}
+exports.getCollectibles = getCollectibles;
+/**
+ * Helper function to get all of the heart pickup entities in the room.
+ *
+ * @param heartSubType Optional. If specified, will only get the hearts that match the sub-type.
+ *                     Default is -1, which matches every sub-type.
+ */
+function getHearts(heartSubType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.HEART, heartSubType);
+}
+exports.getHearts = getHearts;
+/**
+ * Helper function to get all of the key pickup entities in the room.
+ *
+ * @param keySubType Optional. If specified, will only get the keys that match the sub-type. Default
+ *                   is -1, which matches every sub-type.
+ */
+function getKeys(keySubType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.KEY, keySubType);
+}
+exports.getKeys = getKeys;
+/**
+ * Helper function to get all of the pill entities in the room.
+ *
+ * @param pillColor Optional. If specified, will only get the pills that match the sub-type. Default
+ *                  is -1, which matches every sub-type.
+ */
+function getPills(pillColor = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.PILL, pillColor);
+}
+exports.getPills = getPills;
+/**
+ * Helper function to get all of the sack (i.e. grab bag) entities in the room.
+ *
+ * @param sackSubType Optional. If specified, will only get the sacks that match the sub-type.
+ *                    Default is -1, which matches every sub-type.
+ */
+function getSacks(sackSubType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.SACK, sackSubType);
+}
+exports.getSacks = getSacks;
+/**
+ * Helper function to get all of the trinket entities in the room.
+ *
+ * @param trinketType Optional. If specified, will only get the trinkets that match the sub-type.
+ *                    Default is -1, which matches every sub-type.
+ */
+function getTrinkets(trinketType = -1) {
+    return (0, entitiesSpecific_1.getPickups)(isaac_typescript_definitions_1.PickupVariant.TRINKET, trinketType);
+}
+exports.getTrinkets = getTrinkets;
+/**
+ * Helper function to remove all of the batteries in the room.
+ *
+ * @param batterySubType Optional. If specified, will only remove the batteries that match this
+ *                       sub-type. Default is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of cards.
+ * @returns The batteries that were removed.
+ */
+function removeAllBatteries(batterySubType = -1, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.LIL_BATTERY, batterySubType, cap);
+}
+exports.removeAllBatteries = removeAllBatteries;
+/**
+ * Helper function to remove all of the bomb pickups in the room. (Specifically, this refers to bomb
+ * pickups, not the `EntityBomb` class.)
+ *
+ * @param bombSubType Optional. If specified, will only remove bombs that match this sub-type.
+ *                    Default is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of bombs.
+ * @returns The bombs that were removed.
+ */
+function removeAllBombPickups(bombSubType = -1, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.BOMB, bombSubType, cap);
+}
+exports.removeAllBombPickups = removeAllBombPickups;
+/**
+ * Helper function to remove all of the cards in the room.
+ *
+ * @param cardType Optional. If specified, will only remove cards that match this sub-type. Default
+ *                 is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of cards.
+ * @returns The cards that were removed.
+ */
+function removeAllCards(cardType = -1, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.CARD, cardType, cap);
+}
+exports.removeAllCards = removeAllCards;
+/**
+ * Helper function to remove all of the chests in the room. Specifically, this is all of the pickups
+ * with a variant in the `CHEST_PICKUP_VARIANTS` constant.
+ *
+ * @param subType Optional. If specified, will only remove chests that match this sub-type. Default
+ *                is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of chests.
+ * @returns The chests that were removed.
+ */
+function removeAllChests(subType = -1, cap) {
+    const chests = getChests(subType);
+    return (0, entities_1.removeEntities)(chests, cap);
+}
+exports.removeAllChests = removeAllChests;
+/**
+ * Helper function to remove all of the coins in the room.
+ *
+ * @param coinSubType Optional. If specified, will only remove coins that match this sub-type.
+ *                    Default is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of coins.
+ * @returns The coins that were removed.
+ */
+function removeAllCoins(coinSubType, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.COIN, coinSubType, cap);
+}
+exports.removeAllCoins = removeAllCoins;
+/**
+ * Helper function to remove all of the collectibles in the room.
+ *
+ * @param collectibleType Optional. If specified, will only remove collectibles that match this
+ *                        sub-type. Default is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of collectibles.
+ * @returns The collectibles that were removed.
+ */
+function removeAllCollectibles(collectibleType, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.COLLECTIBLE, collectibleType, cap);
+}
+exports.removeAllCollectibles = removeAllCollectibles;
+/**
+ * Helper function to remove all of the heart pickup entities in the room.
+ *
+ * @param heartSubType Optional. If specified, will only remove hearts that match this sub-type.
+ *                     Default is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of hearts.
+ * @returns The hearts that were removed.
+ */
+function removeAllHearts(heartSubType, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.HEART, heartSubType, cap);
+}
+exports.removeAllHearts = removeAllHearts;
+/**
+ * Helper function to remove all of the keys in the room.
+ *
+ * @param keySubType Optional. If specified, will only remove keys that match this sub-type. Default
+ *                   is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of keys.
+ * @returns The keys that were removed.
+ */
+function removeAllKeys(keySubType, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.KEY, keySubType, cap);
+}
+exports.removeAllKeys = removeAllKeys;
+/**
+ * Helper function to remove all of the pills in the room.
+ *
+ * @param pillColor Optional. If specified, will only remove pills that match this sub-type. Default
+ *                  is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of pills.
+ * @returns The pills that were removed.
+ */
+function removeAllPills(pillColor, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.PILL, pillColor, cap);
+}
+exports.removeAllPills = removeAllPills;
+/**
+ * Helper function to remove all of the sacks (i.e. grab bags) in the room.
+ *
+ * @param sackSubType Optional. If specified, will only remove sacks that match this sub-type.
+ *                    Default is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of sacks.
+ * @returns The sacks that were removed.
+ */
+function removeAllSacks(sackSubType, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.SACK, sackSubType, cap);
+}
+exports.removeAllSacks = removeAllSacks;
+/**
+ * Helper function to remove all of the trinkets in the room.
+ *
+ * @param trinketType Optional. If specified, will only remove trinkets that match this sub-type.
+ *                    Default is -1, which matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of trinkets.
+ * @returns The trinkets that were removed.
+ */
+function removeAllTrinkets(trinketType, cap) {
+    return (0, entitiesSpecific_1.removeAllPickups)(isaac_typescript_definitions_1.PickupVariant.TRINKET, trinketType, cap);
+}
+exports.removeAllTrinkets = removeAllTrinkets;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90).
+ */
+function spawnBattery(batterySubType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.LIL_BATTERY, batterySubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnBattery = spawnBattery;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.LIL_BATTERY` (90)
+ * and a specific seed.
+ */
+function spawnBatteryWithSeed(batterySubType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnBattery(batterySubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnBatteryWithSeed = spawnBatteryWithSeed;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.BOMB` (40). */
+function spawnBombPickup(bombSubType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.BOMB, bombSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnBombPickup = spawnBombPickup;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.BOMB` (40) and a
+ * specific seed.
+ */
+function spawnBombPickupWithSeed(bombSubType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnBombPickup(bombSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnBombPickupWithSeed = spawnBombPickupWithSeed;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.CARD` (300). */
+function spawnCard(cardType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.CARD, cardType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnCard = spawnCard;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.CARD` (300) and a
+ * specific seed.
+ */
+function spawnCardWithSeed(cardType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnCard(cardType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnCardWithSeed = spawnCardWithSeed;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20). */
+function spawnCoin(coinSubType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.COIN, coinSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnCoin = spawnCoin;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.COIN` (20) and a
+ * specific seed.
+ */
+function spawnCoinWithSeed(coinSubType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnCoin(coinSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnCoinWithSeed = spawnCoinWithSeed;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.HEART` (10). */
+function spawnHeart(heartSubType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.HEART, heartSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnHeart = spawnHeart;
+function spawnHeartWithSeed(heartSubType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnHeart(heartSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnHeartWithSeed = spawnHeartWithSeed;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30). */
+function spawnKey(keySubType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.KEY, keySubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnKey = spawnKey;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.KEY` (30) and a
+ * specific seed.
+ */
+function spawnKeyWithSeed(keySubType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnKey(keySubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnKeyWithSeed = spawnKeyWithSeed;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70). */
+function spawnPill(pillColor, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.PILL, pillColor, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnPill = spawnPill;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.PILL` (70) and a
+ * specific seed.
+ */
+function spawnPillWithSeed(pillColor, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnPill(pillColor, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnPillWithSeed = spawnPillWithSeed;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69). */
+function spawnSack(sackSubType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.SACK, sackSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnSack = spawnSack;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.SACK` (69) and a
+ * specific seed.
+ */
+function spawnSackWithSeed(sackSubType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnSack(sackSubType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnSackWithSeed = spawnSackWithSeed;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350).
+ */
+function spawnTrinket(trinketType, positionOrGridIndex, velocity = constants_1.VectorZero, spawner = undefined, seedOrRNG = undefined) {
+    return (0, entitiesSpecific_1.spawnPickup)(isaac_typescript_definitions_1.PickupVariant.TRINKET, trinketType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnTrinket = spawnTrinket;
+/**
+ * Helper function to spawn a `EntityType.PICKUP` (5) with variant `PickupVariant.TRINKET` (350) and
+ * a specific seed.
+ */
+function spawnTrinketWithSeed(trinketType, positionOrGridIndex, seedOrRNG, velocity = constants_1.VectorZero, spawner = undefined) {
+    return spawnTrinket(trinketType, positionOrGridIndex, velocity, spawner, seedOrRNG);
+}
+exports.spawnTrinketWithSeed = spawnTrinketWithSeed;

package/dist/functions/pills.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isVanillaPillEffect = exports.isValidPillEffect = exports.isModdedPillEffect = exports.isHorsePill = exports.isGoldPill = exports.getVanillaPillEffectsOfType = exports.getPillEffectType = exports.getPillEffectName = exports.getPillEffectClass = exports.getPillColorFromEffect = exports.getPHDPillEffect = exports.getNormalPillColors = exports.getNormalPillColorFromHorse = exports.getHorsePillColors = exports.getHorsePillColor = exports.getFalsePHDPillEffect = exports.getAllPillColors = void 0;
+const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
+const cachedEnumValues_1 = require("../arrays/cachedEnumValues");
+const cachedClasses_1 = require("../core/cachedClasses");
+const constantsFirstLast_1 = require("../core/constantsFirstLast");
+const PHDPillConversionsMap_1 = require("../maps/PHDPillConversionsMap");
+const falsePHDPillConversionsMap_1 = require("../maps/falsePHDPillConversionsMap");
+const pillEffectClasses_1 = require("../objects/pillEffectClasses");
+const pillEffectNames_1 = require("../objects/pillEffectNames");
+const pillEffectTypeToPillEffects_1 = require("../objects/pillEffectTypeToPillEffects");
+const pillEffectTypes_1 = require("../objects/pillEffectTypes");
+const types_1 = require("./types");
+const utils_1 = require("./utils");
+/**
+ * Add this to a `PillColor` to get the corresponding giant pill color.
+ *
+ * Corresponds to the vanilla `PillColor.GIANT_FLAG` value.
+ *
+ * 1 << 11
+ */
+const HORSE_PILL_COLOR_ADJUSTMENT = 2048;
+/**
+ * Helper function to get an array with every non-null pill color. This includes all gold colors and
+ * all horse colors.
+ */
+function getAllPillColors() {
+    return cachedEnumValues_1.PILL_COLOR_VALUES.slice(1); // Remove `PillColor.NULL`
+}
+exports.getAllPillColors = getAllPillColors;
+/**
+ * Helper function to get the associated pill effect after False PHD is acquired. If a pill effect
+ * is not altered by False PHD, then the same pill effect will be returned.
+ */
+function getFalsePHDPillEffect(pillEffect) {
+    const convertedPillEffect = falsePHDPillConversionsMap_1.FALSE_PHD_PILL_CONVERSIONS_MAP.get(pillEffect);
+    return convertedPillEffect ?? pillEffect;
+}
+exports.getFalsePHDPillEffect = getFalsePHDPillEffect;
+/**
+ * Helper function to get the corresponding horse pill color from a normal pill color.
+ *
+ * For example, passing `PillColor.BLUE_BLUE` would result in 2049, which is the value that
+ * corresponds to the horse pill color for blue/blue.
+ *
+ * If passed a horse pill color, this function will return the unmodified pill color.
+ */
+function getHorsePillColor(pillColor) {
+    return isHorsePill(pillColor)
+        ? pillColor
+        : pillColor + HORSE_PILL_COLOR_ADJUSTMENT;
+}
+exports.getHorsePillColor = getHorsePillColor;
+/** Helper function to get an array with every non-gold horse pill color. */
+function getHorsePillColors() {
+    return (0, utils_1.iRange)(constantsFirstLast_1.FIRST_HORSE_PILL_COLOR, constantsFirstLast_1.LAST_HORSE_PILL_COLOR);
+}
+exports.getHorsePillColors = getHorsePillColors;
+/**
+ * Helper function to get the corresponding normal pill color from a horse pill color.
+ *
+ * For example, passing 2049 would result in `PillColor.BLUE_BLUE`.
+ *
+ * If called with a non-horse pill color, this function will return back the same color.
+ */
+function getNormalPillColorFromHorse(pillColor) {
+    return isHorsePill(pillColor)
+        ? (0, types_1.asPillColor)(pillColor - HORSE_PILL_COLOR_ADJUSTMENT)
+        : pillColor;
+}
+exports.getNormalPillColorFromHorse = getNormalPillColorFromHorse;
+/** Helper function to get an array with every non-gold and non-horse pill color. */
+function getNormalPillColors() {
+    return (0, utils_1.iRange)(constantsFirstLast_1.FIRST_PILL_COLOR, constantsFirstLast_1.LAST_NORMAL_PILL_COLOR);
+}
+exports.getNormalPillColors = getNormalPillColors;
+/**
+ * Helper function to get the associated pill effect after PHD is acquired. If a pill effect is not
+ * altered by PHD, then the same pill effect will be returned.
+ */
+function getPHDPillEffect(pillEffect) {
+    const convertedPillEffect = PHDPillConversionsMap_1.PHD_PILL_CONVERSIONS_MAP.get(pillEffect);
+    return convertedPillEffect ?? pillEffect;
+}
+exports.getPHDPillEffect = getPHDPillEffect;
+/**
+ * Helper function to get the corresponding pill color from an effect by repeatedly using the
+ * `ItemPool.GetPillEffect` method.
+ *
+ * Note that this will return the corresponding effect even if the passed pill color is not yet
+ * identified by the player.
+ *
+ * Returns `PillColor.NULL` if there is the corresponding pill color cannot be found.
+ *
+ * This function is especially useful in the `POST_USE_PILL` callback, since at that point, the used
+ * pill is already consumed, and the callback only passes the effect. In this specific circumstance,
+ * consider using the `POST_USE_PILL_FILTER` callback instead of the `POST_USE_PILL` callback, since
+ * it correctly passes the color and handles the case of horse pills.
+ */
+function getPillColorFromEffect(pillEffect) {
+    const itemPool = cachedClasses_1.game.GetItemPool();
+    const normalPillColors = getNormalPillColors();
+    for (const normalPillColor of normalPillColors) {
+        const normalPillEffect = itemPool.GetPillEffect(normalPillColor);
+        if (normalPillEffect === pillEffect) {
+            return normalPillColor;
+        }
+    }
+    return isaac_typescript_definitions_1.PillColor.NULL;
+}
+exports.getPillColorFromEffect = getPillColorFromEffect;
+/**
+ * Helper function to get a pill effect class from a PillEffect enum value. In this context, the
+ * class is equal to the numerical prefix in the "class" tag in the "pocketitems.xml" file. Use the
+ * `getPillEffectType` helper function to determine whether the pill effect is positive, negative,
+ * or neutral.
+ *
+ * Due to limitations in the API, this function will not work properly for modded pill effects, and
+ * will always return `DEFAULT_PILL_EFFECT_CLASS` in those cases.
+ */
+function getPillEffectClass(pillEffect) {
+    // `ItemConfigPillEffect` does not contain the "class" tag, so we must manually compile a map of
+    // pill effect classes. Modded pill effects are not included in the map.
+    const pillEffectClass = pillEffectClasses_1.PILL_EFFECT_CLASSES[pillEffect];
+    // Handle modded pill effects.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return pillEffectClass ?? pillEffectClasses_1.DEFAULT_PILL_EFFECT_CLASS;
+}
+exports.getPillEffectClass = getPillEffectClass;
+/**
+ * Helper function to get a pill effect name from a `PillEffect`. Returns "Unknown" if the provided
+ * pill effect is not valid.
+ *
+ * This function works for both vanilla and modded pill effects.
+ *
+ * For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
+ */
+function getPillEffectName(pillEffect) {
+    // `ItemConfigPillEffect.Name` is bugged with vanilla pill effects on patch v1.7.6, so we use a
+    // hard-coded map as a workaround.
+    const pillEffectName = pillEffectNames_1.PILL_EFFECT_NAMES[pillEffect];
+    // Handle modded pill effects.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    if (pillEffectName !== undefined) {
+        return pillEffectName;
+    }
+    const itemConfigPillEffect = cachedClasses_1.itemConfig.GetPillEffect(pillEffect);
+    if (itemConfigPillEffect !== undefined) {
+        return itemConfigPillEffect.Name;
+    }
+    return pillEffectNames_1.DEFAULT_PILL_EFFECT_NAME;
+}
+exports.getPillEffectName = getPillEffectName;
+/**
+ * Helper function to get a pill effect type from a `PillEffect` enum value. In this context, the
+ * type is equal to positive, negative, or neutral. This is derived from the suffix of the "class"
+ * tag in the "pocketitems.xml" file. Use the `getPillEffectClass` helper function to determine the
+ * "power" of the pill.
+ *
+ * Due to limitations in the API, this function will not work properly for modded pill effects, and
+ * will always return `DEFAULT_PILL_EFFECT_TYPE` in those cases.
+ */
+function getPillEffectType(pillEffect) {
+    // `ItemConfigPillEffect` does not contain the "class" tag, so we must manually compile a map of
+    // pill effect classes. Modded pill effects are not included in the map.
+    const pillEffectType = pillEffectTypes_1.PILL_EFFECT_TYPES[pillEffect];
+    // Handle modded pill effects.
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return pillEffectType ?? pillEffectTypes_1.DEFAULT_PILL_EFFECT_TYPE;
+}
+exports.getPillEffectType = getPillEffectType;
+function getVanillaPillEffectsOfType(pillEffectType) {
+    return pillEffectTypeToPillEffects_1.PILL_EFFECT_TYPE_TO_PILL_EFFECTS[pillEffectType];
+}
+exports.getVanillaPillEffectsOfType = getVanillaPillEffectsOfType;
+/** Helper function to see if the given pill color is either a gold pill or a horse gold pill. */
+function isGoldPill(pillColor) {
+    return pillColor === isaac_typescript_definitions_1.PillColor.GOLD || pillColor === isaac_typescript_definitions_1.PillColor.HORSE_GOLD;
+}
+exports.isGoldPill = isGoldPill;
+/** Helper function to see if the given pill color is a horse pill. */
+function isHorsePill(pillColor) {
+    return (0, types_1.asNumber)(pillColor) > HORSE_PILL_COLOR_ADJUSTMENT;
+}
+exports.isHorsePill = isHorsePill;
+function isModdedPillEffect(pillEffect) {
+    return !isVanillaPillEffect(pillEffect);
+}
+exports.isModdedPillEffect = isModdedPillEffect;
+function isValidPillEffect(pillEffect) {
+    const potentialPillEffect = (0, types_1.asPillEffect)(pillEffect);
+    const itemConfigPillEffect = cachedClasses_1.itemConfig.GetPillEffect(potentialPillEffect);
+    return itemConfigPillEffect !== undefined;
+}
+exports.isValidPillEffect = isValidPillEffect;
+function isVanillaPillEffect(pillEffect) {
+    return pillEffect <= constantsFirstLast_1.LAST_VANILLA_PILL_EFFECT;
+}
+exports.isVanillaPillEffect = isVanillaPillEffect;

package/dist/functions/playerCenter.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.movePlayersToCenter = void 0;
+const isaac_typescript_definitions_1 = require("isaac-typescript-definitions");
+const cachedClasses_1 = require("../core/cachedClasses");
+const constants_1 = require("../core/constants");
+const familiars_1 = require("./familiars");
+const math_1 = require("./math");
+const playerIndex_1 = require("./playerIndex");
+/**
+ * Helper function to move all of the players to where they would normally go when arriving at a new
+ * floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
+ * door.)
+ *
+ * If there is more than one player, they will be distributed around the center in a circle.
+ *
+ * This function emulates what happens in the vanilla game when you travel to a new floor.
+ *
+ * @param radius Optional. The radius of the circle. Default is 10.
+ */
+function movePlayersToCenter(radius = 10) {
+    const isGreedMode = cachedClasses_1.game.IsGreedMode();
+    const startingPosition = isGreedMode
+        ? constants_1.NEW_FLOOR_STARTING_POSITION_GREED_MODE
+        : constants_1.NEW_FLOOR_STARTING_POSITION_NORMAL_MODE;
+    const players = (0, playerIndex_1.getAllPlayers)();
+    const firstPlayer = players[0];
+    if (firstPlayer === undefined) {
+        return;
+    }
+    // If there is only one player, we can move them exactly to the center of the room.
+    if (players.length === 1) {
+        movePlayerAndTheirFamiliars(firstPlayer, startingPosition);
+        return;
+    }
+    // If there is more than one player, spread them out in a circle around the center of the room.
+    // (This is what happens in vanilla.)
+    const circlePoints = (0, math_1.getCircleDiscretizedPoints)(startingPosition, radius, players.length, 1, 1, isaac_typescript_definitions_1.Direction.LEFT);
+    for (const [i, player] of players.entries()) {
+        const circlePosition = circlePoints[i];
+        if (circlePosition !== undefined) {
+            player.Position = circlePosition;
+        }
+    }
+}
+exports.movePlayersToCenter = movePlayersToCenter;
+function movePlayerAndTheirFamiliars(player, position) {
+    player.Position = position;
+    const familiars = (0, familiars_1.getPlayerFamiliars)(player);
+    for (const familiar of familiars) {
+        familiar.Position = position;
+    }
+}