isaacscript-common 2.3.0 → 2.3.1

package/functions/pickups.lua

@@ -0,0 +1,407 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____coinSubTypeToValue = require("objects.coinSubTypeToValue")
+local COIN_SUBTYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUBTYPE_TO_VALUE
+local DEFAULT_COIN_VALUE = ____coinSubTypeToValue.DEFAULT_COIN_VALUE
+local ____chestPickupVariantsSet = require("sets.chestPickupVariantsSet")
+local CHEST_PICKUP_VARIANTS = ____chestPickupVariantsSet.CHEST_PICKUP_VARIANTS
+local ____redHeartSubTypesSet = require("sets.redHeartSubTypesSet")
+local RED_HEART_SUB_TYPES_SET = ____redHeartSubTypesSet.RED_HEART_SUB_TYPES_SET
+local ____entitySpecific = require("functions.entitySpecific")
+local getPickups = ____entitySpecific.getPickups
+local removeAllPickups = ____entitySpecific.removeAllPickups
+local spawnPickup = ____entitySpecific.spawnPickup
+local ____pickupVariants = require("functions.pickupVariants")
+local isHeart = ____pickupVariants.isHeart
+function ____exports.getBatteries(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.LIL_BATTERY, matchingSubType)
+end
+function ____exports.getCards(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.TAROT_CARD, matchingSubType)
+end
+function ____exports.getCoinValue(self, coinSubType)
+    local value = COIN_SUBTYPE_TO_VALUE[coinSubType]
+    return value == nil and DEFAULT_COIN_VALUE or value
+end
+function ____exports.getCoins(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.COIN, matchingSubType)
+end
+function ____exports.getCollectibles(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.COLLECTIBLE, matchingSubType)
+end
+function ____exports.getHearts(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.HEART, matchingSubType)
+end
+function ____exports.getKeys(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.KEY, matchingSubType)
+end
+function ____exports.getPills(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.PILL, matchingSubType)
+end
+function ____exports.getRedHearts(self)
+    local hearts = ____exports.getHearts(nil)
+    return __TS__ArrayFilter(
+        hearts,
+        function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
+    )
+end
+function ____exports.getSacks(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.SACK, matchingSubType)
+end
+function ____exports.getTrinkets(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.TRINKET, matchingSubType)
+end
+function ____exports.isChest(self, pickup)
+    return CHEST_PICKUP_VARIANTS:has(pickup.Variant)
+end
+function ____exports.isRedHeart(self, pickup)
+    return isHeart(nil, pickup) and RED_HEART_SUB_TYPES_SET:has(pickup.SubType)
+end
+function ____exports.removeAllBatteries(self, batterySubType, cap)
+    return removeAllPickups(nil, PickupVariant.LIL_BATTERY, batterySubType, cap)
+end
+function ____exports.removeAllCards(self, card, cap)
+    return removeAllPickups(nil, PickupVariant.TAROT_CARD, card, cap)
+end
+function ____exports.removeAllCoins(self, coinSubType, cap)
+    return removeAllPickups(nil, PickupVariant.COIN, coinSubType, cap)
+end
+function ____exports.removeAllCollectibles(self, collectibleType, cap)
+    return removeAllPickups(nil, PickupVariant.COLLECTIBLE, collectibleType, cap)
+end
+function ____exports.removeAllHearts(self, heartSubType, cap)
+    return removeAllPickups(nil, PickupVariant.HEART, heartSubType, cap)
+end
+function ____exports.removeAllKeys(self, keySubType, cap)
+    return removeAllPickups(nil, PickupVariant.KEY, keySubType, cap)
+end
+function ____exports.removeAllPills(self, pillColor, cap)
+    return removeAllPickups(nil, PickupVariant.PILL, pillColor, cap)
+end
+function ____exports.removeAllSacks(self, sackSubType, cap)
+    return removeAllPickups(nil, PickupVariant.TRINKET, sackSubType, cap)
+end
+function ____exports.removeAllTrinkets(self, trinketType, cap)
+    return removeAllPickups(nil, PickupVariant.TRINKET, trinketType, cap)
+end
+function ____exports.spawnBattery(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.LIL_BATTERY,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnBatteryWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnBattery(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnCard(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.TAROT_CARD,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnCardWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnCard(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnCoin(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.COIN,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnCoinWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnCoin(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnHeart(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.HEART,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnHeartWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnHeart(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnKey(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.KEY,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnKeyWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnKey(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnPill(self, pillColor, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.PILL,
+        pillColor,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnPillWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnPill(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnSack(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.SACK,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnSackWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnSack(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnTrinket(self, subType, position, velocity, spawner, seed)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    if seed == nil then
+        seed = nil
+    end
+    return spawnPickup(
+        nil,
+        PickupVariant.TRINKET,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+function ____exports.spawnTrinketWithSeed(self, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnTrinket(
+        nil,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+return ____exports

package/functions/pills.d.ts

@@ -0,0 +1,69 @@
+import { ItemConfigPillEffectClass, ItemConfigPillEffectType, PillColor, PillEffect } from "isaac-typescript-definitions";
+/**
+ * Helper function to get an array with every non-null pill color. This includes all gold colors and
+ * all horse colors.
+ */
+export declare function getAllPillColors(): PillColor[];
+/**
+ * Helper function to get an array with every valid pill effect. This includes modded pill effects.
+ */
+export declare function getAllPillEffects(): PillEffect[];
+/**
+ * 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.
+ */
+export declare function getHorsePillColor(pillColor: PillColor): PillColor;
+/** Helper function to get an array with every non-gold horse pill color. */
+export declare function getHorsePillColors(): PillColor[];
+/**
+ * Helper function to get an array with every modded pill effect.
+ *
+ * Returns an empty array if there are no modded pill effects.
+ */
+export declare function getModdedPillEffects(): PillEffect[];
+/**
+ * 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.
+ */
+export declare function getNormalPillColorFromHorse(pillColor: PillColor): PillColor;
+/** Helper function to get an array with every non-gold and non-horse pill color. */
+export declare function getNormalPillColors(): PillColor[];
+/**
+ * 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 or not 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.
+ */
+export declare function getPillEffectClass(pillEffect: PillEffect): ItemConfigPillEffectClass;
+/**
+ * Helper function to get a pill effect name from a PillEffect enum value.
+ *
+ * For example:
+ *
+ * ```ts
+ * const pillEffect = PillEffect.BAD_GAS;
+ * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"
+ * ```
+ */
+export declare function getPillEffectName(pillEffect: PillEffect): string;
+/**
+ * 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 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.
+ */
+export declare function getPillEffectType(pillEffect: PillEffect): ItemConfigPillEffectType;
+/** Helper function to get an array with every vanilla pill effect. */
+export declare function getVanillaPillEffects(): PillEffect[];
+export declare function isHorsePill(pillColor: PillColor): boolean;

package/functions/pills.lua

@@ -0,0 +1,83 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArraySlice = ____lualib.__TS__ArraySlice
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PillColor = ____isaac_2Dtypescript_2Ddefinitions.PillColor
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____constantsFirstLast = require("constantsFirstLast")
+local FIRST_HORSE_PILL_COLOR = ____constantsFirstLast.FIRST_HORSE_PILL_COLOR
+local FIRST_MODDED_PILL_EFFECT = ____constantsFirstLast.FIRST_MODDED_PILL_EFFECT
+local FIRST_PILL_COLOR = ____constantsFirstLast.FIRST_PILL_COLOR
+local FIRST_PILL_EFFECT = ____constantsFirstLast.FIRST_PILL_EFFECT
+local LAST_HORSE_PILL_COLOR = ____constantsFirstLast.LAST_HORSE_PILL_COLOR
+local LAST_NORMAL_PILL_COLOR = ____constantsFirstLast.LAST_NORMAL_PILL_COLOR
+local LAST_PILL_EFFECT = ____constantsFirstLast.LAST_PILL_EFFECT
+local LAST_VANILLA_PILL_EFFECT = ____constantsFirstLast.LAST_VANILLA_PILL_EFFECT
+local ____pillEffectClasses = require("objects.pillEffectClasses")
+local DEFAULT_PILL_EFFECT_CLASS = ____pillEffectClasses.DEFAULT_PILL_EFFECT_CLASS
+local PILL_EFFECT_CLASSES = ____pillEffectClasses.PILL_EFFECT_CLASSES
+local ____pillEffectNames = require("objects.pillEffectNames")
+local DEFAULT_PILL_EFFECT_NAME = ____pillEffectNames.DEFAULT_PILL_EFFECT_NAME
+local PILL_EFFECT_NAMES = ____pillEffectNames.PILL_EFFECT_NAMES
+local ____pillEffectTypes = require("objects.pillEffectTypes")
+local DEFAULT_PILL_EFFECT_TYPE = ____pillEffectTypes.DEFAULT_PILL_EFFECT_TYPE
+local PILL_EFFECT_TYPES = ____pillEffectTypes.PILL_EFFECT_TYPES
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
+local HORSE_PILL_ADJUSTMENT = 2048
+function ____exports.getAllPillColors(self)
+    local pillColors = getEnumValues(nil, PillColor)
+    __TS__ArraySlice(pillColors)
+    return pillColors
+end
+function ____exports.getAllPillEffects(self)
+    return irange(nil, FIRST_PILL_EFFECT, LAST_PILL_EFFECT)
+end
+function ____exports.getHorsePillColor(self, pillColor)
+    return pillColor + HORSE_PILL_ADJUSTMENT
+end
+function ____exports.getHorsePillColors(self)
+    return irange(nil, FIRST_HORSE_PILL_COLOR, LAST_HORSE_PILL_COLOR)
+end
+function ____exports.getModdedPillEffects(self)
+    if LAST_VANILLA_PILL_EFFECT == LAST_PILL_EFFECT then
+        return {}
+    end
+    return irange(nil, FIRST_MODDED_PILL_EFFECT, LAST_PILL_EFFECT)
+end
+function ____exports.getNormalPillColorFromHorse(self, pillColor)
+    local normalPillColor = pillColor - HORSE_PILL_ADJUSTMENT
+    return normalPillColor > PillColor.NULL and normalPillColor or pillColor
+end
+function ____exports.getNormalPillColors(self)
+    return irange(nil, FIRST_PILL_COLOR, LAST_NORMAL_PILL_COLOR)
+end
+function ____exports.getPillEffectClass(self, pillEffect)
+    local pillEffectClass = PILL_EFFECT_CLASSES[pillEffect]
+    return pillEffectClass == nil and DEFAULT_PILL_EFFECT_CLASS or pillEffectClass
+end
+function ____exports.getPillEffectName(self, pillEffect)
+    local pillEffectName = PILL_EFFECT_NAMES[pillEffect]
+    if pillEffectName ~= nil and pillEffectName ~= DEFAULT_PILL_EFFECT_NAME then
+        return pillEffectName
+    end
+    local itemConfigPillEffect = itemConfig:GetPillEffect(pillEffect)
+    if itemConfigPillEffect ~= nil then
+        return itemConfigPillEffect.Name
+    end
+    return DEFAULT_PILL_EFFECT_NAME
+end
+function ____exports.getPillEffectType(self, pillEffect)
+    local pillEffectClass = PILL_EFFECT_TYPES[pillEffect]
+    return pillEffectClass == nil and DEFAULT_PILL_EFFECT_TYPE or pillEffectClass
+end
+function ____exports.getVanillaPillEffects(self)
+    return irange(nil, FIRST_PILL_EFFECT, LAST_VANILLA_PILL_EFFECT)
+end
+function ____exports.isHorsePill(self, pillColor)
+    return pillColor > HORSE_PILL_ADJUSTMENT
+end
+return ____exports