isaacscript-common 2.3.0 → 2.3.1

package/functions/easing.d.ts

@@ -0,0 +1,30 @@
+export declare function easeInSine(x: number): number;
+export declare function easeOutSine(x: number): number;
+export declare function easeInOutSine(x: number): number;
+export declare function easeInCubic(x: number): number;
+export declare function easeOutCubic(x: number): number;
+export declare function easeInOutCubic(x: number): number;
+export declare function easeInQuint(x: number): number;
+export declare function easeOutQuint(x: number): number;
+export declare function easeInOutQuint(x: number): number;
+export declare function easeInCirc(x: number): number;
+export declare function easeOutCirc(x: number): number;
+export declare function easeInOutCirc(x: number): number;
+export declare function easeInElastic(x: number): number;
+export declare function easeOutElastic(x: number): number;
+export declare function easeInOutElastic(x: number): number;
+export declare function easeInQuad(x: number): number;
+export declare function easeOutQuad(x: number): number;
+export declare function easeInOutQuad(x: number): number;
+export declare function easeInQuart(x: number): number;
+export declare function easeOutQuart(x: number): number;
+export declare function easeInOutQuart(x: number): number;
+export declare function easeInExpo(x: number): number;
+export declare function easeOutExpo(x: number): number;
+export declare function easeInOutExpo(x: number): number;
+export declare function easeInBack(x: number): number;
+export declare function easeOutBack(x: number): number;
+export declare function easeInOutBack(x: number): number;
+export declare function easeInBounce(x: number): number;
+export declare function easeOutBounce(x: number): number;
+export declare function easeInOutBounce(x: number): number;

package/functions/easing.lua

@@ -0,0 +1,115 @@
+local ____exports = {}
+function ____exports.easeOutBounce(self, x)
+    local n1 = 7.5625
+    local d1 = 2.75
+    if x < 1 / d1 then
+        return n1 * x * x
+    end
+    if x < 2 / d1 then
+        x = x - 1.5 / d1
+        return n1 * x * x + 0.75
+    end
+    if x < 2.5 / d1 then
+        x = x - 2.25 / d1
+        return n1 * x * x + 0.9375
+    end
+    x = x - 2.625 / d1
+    return n1 * x * x + 0.984375
+end
+function ____exports.easeInSine(self, x)
+    return 1 - math.cos(x * math.pi / 2)
+end
+function ____exports.easeOutSine(self, x)
+    return math.sin(x * math.pi / 2)
+end
+function ____exports.easeInOutSine(self, x)
+    return -(math.cos(math.pi * x) - 1) / 2
+end
+function ____exports.easeInCubic(self, x)
+    return x * x * x
+end
+function ____exports.easeOutCubic(self, x)
+    return 1 - (1 - x) ^ 3
+end
+function ____exports.easeInOutCubic(self, x)
+    return x < 0.5 and 4 * x * x * x or 1 - (-2 * x + 2) ^ 3 / 2
+end
+function ____exports.easeInQuint(self, x)
+    return x * x * x * x * x
+end
+function ____exports.easeOutQuint(self, x)
+    return 1 - (1 - x) ^ 5
+end
+function ____exports.easeInOutQuint(self, x)
+    return x < 0.5 and 16 * x * x * x * x * x or 1 - (-2 * x + 2) ^ 5 / 2
+end
+function ____exports.easeInCirc(self, x)
+    return 1 - math.sqrt(1 - x ^ 2)
+end
+function ____exports.easeOutCirc(self, x)
+    return math.sqrt(1 - (x - 1) ^ 2)
+end
+function ____exports.easeInOutCirc(self, x)
+    return x < 0.5 and (1 - math.sqrt(1 - (2 * x) ^ 2)) / 2 or (math.sqrt(1 - (-2 * x + 2) ^ 2) + 1) / 2
+end
+function ____exports.easeInElastic(self, x)
+    local c4 = 2 * math.pi / 3
+    return x == 0 and 0 or (x == 1 and 1 or -2 ^ (10 * x - 10) * math.sin((x * 10 - 10.75) * c4))
+end
+function ____exports.easeOutElastic(self, x)
+    local c4 = 2 * math.pi / 3
+    return x == 0 and 0 or (x == 1 and 1 or 2 ^ (-10 * x) * math.sin((x * 10 - 0.75) * c4) + 1)
+end
+function ____exports.easeInOutElastic(self, x)
+    local c5 = 2 * math.pi / 4.5
+    return x == 0 and 0 or (x == 1 and 1 or (x < 0.5 and -(2 ^ (20 * x - 10) * math.sin((20 * x - 11.125) * c5)) / 2 or 2 ^ (-20 * x + 10) * math.sin((20 * x - 11.125) * c5) / 2 + 1))
+end
+function ____exports.easeInQuad(self, x)
+    return x * x
+end
+function ____exports.easeOutQuad(self, x)
+    return 1 - (1 - x) * (1 - x)
+end
+function ____exports.easeInOutQuad(self, x)
+    return x < 0.5 and 2 * x * x or 1 - (-2 * x + 2) ^ 2 / 2
+end
+function ____exports.easeInQuart(self, x)
+    return x * x * x * x
+end
+function ____exports.easeOutQuart(self, x)
+    return 1 - (1 - x) ^ 4
+end
+function ____exports.easeInOutQuart(self, x)
+    return x < 0.5 and 8 * x * x * x * x or 1 - (-2 * x + 2) ^ 4 / 2
+end
+function ____exports.easeInExpo(self, x)
+    return x == 0 and 0 or 2 ^ (10 * x - 10)
+end
+function ____exports.easeOutExpo(self, x)
+    return x == 1 and 1 or 1 - 2 ^ (-10 * x)
+end
+function ____exports.easeInOutExpo(self, x)
+    return x == 0 and 0 or (x == 1 and 1 or (x < 0.5 and 2 ^ (20 * x - 10) / 2 or (2 - 2 ^ (-20 * x + 10)) / 2))
+end
+function ____exports.easeInBack(self, x)
+    local c1 = 1.70158
+    local c3 = c1 + 1
+    return c3 * x * x * x - c1 * x * x
+end
+function ____exports.easeOutBack(self, x)
+    local c1 = 1.70158
+    local c3 = c1 + 1
+    return 1 + c3 * (x - 1) ^ 3 + c1 * (x - 1) ^ 2
+end
+function ____exports.easeInOutBack(self, x)
+    local c1 = 1.70158
+    local c2 = c1 * 1.525
+    return x < 0.5 and (2 * x) ^ 2 * ((c2 + 1) * 2 * x - c2) / 2 or ((2 * x - 2) ^ 2 * ((c2 + 1) * (x * 2 - 2) + c2) + 2) / 2
+end
+function ____exports.easeInBounce(self, x)
+    return 1 - ____exports.easeOutBounce(nil, 1 - x)
+end
+function ____exports.easeInOutBounce(self, x)
+    return x < 0.5 and (1 - ____exports.easeOutBounce(nil, 1 - 2 * x)) / 2 or (1 + ____exports.easeOutBounce(nil, 2 * x - 1)) / 2
+end
+return ____exports

package/functions/eden.d.ts

@@ -0,0 +1,3 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+export declare function getEdenPassives(): Set<CollectibleType>;
+export declare function getRandomEdenPassive(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;

package/functions/eden.lua

@@ -0,0 +1,47 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
+local ____collectibles = require("functions.collectibles")
+local isHiddenCollectible = ____collectibles.isHiddenCollectible
+local isPassiveCollectible = ____collectibles.isPassiveCollectible
+local ____collectibleSet = require("functions.collectibleSet")
+local getCollectibleSet = ____collectibleSet.getCollectibleSet
+local ____collectibleTag = require("functions.collectibleTag")
+local collectibleHasTag = ____collectibleTag.collectibleHasTag
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local ____set = require("functions.set")
+local copySet = ____set.copySet
+local getRandomSetElement = ____set.getRandomSetElement
+local EDEN_PASSIVE_COLLECTIBLES_SET = __TS__New(Set)
+local function initCollectibleSet(self)
+    local collectibleSet = getCollectibleSet(nil)
+    for ____, collectibleType in __TS__Iterator(collectibleSet:values()) do
+        if isPassiveCollectible(nil, collectibleType) and not isHiddenCollectible(nil, collectibleType) and not collectibleHasTag(nil, collectibleType, ItemConfigTag.NO_EDEN) then
+            EDEN_PASSIVE_COLLECTIBLES_SET:add(collectibleType)
+        end
+    end
+end
+function ____exports.getEdenPassives(self)
+    if EDEN_PASSIVE_COLLECTIBLES_SET.size == 0 then
+        initCollectibleSet(nil)
+    end
+    return copySet(nil, EDEN_PASSIVE_COLLECTIBLES_SET)
+end
+function ____exports.getRandomEdenPassive(self, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    if EDEN_PASSIVE_COLLECTIBLES_SET.size == 0 then
+        initCollectibleSet(nil)
+    end
+    return getRandomSetElement(nil, EDEN_PASSIVE_COLLECTIBLES_SET, seedOrRNG, exceptions)
+end
+return ____exports

package/functions/entity.d.ts

@@ -0,0 +1,131 @@
+import { EntityType } from "isaac-typescript-definitions";
+import { AnyEntity } from "../types/AnyEntity";
+/**
+ * Helper function to count the number of entities in room. Use this over the vanilla
+ * `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
+ * enemies.
+ *
+ * @param entityType Default is -1. -1 matches every entity type.
+ * @param variant Default is -1. -1 matches every variant.
+ * @param subType Default is -1. -1 matches every sub-type.
+ * @param ignoreFriendly Default is false.
+ */
+export declare function countEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): int;
+/**
+ * Given an array of entities, this helper function returns the closest one to a provided reference
+ * entity.
+ *
+ * For example:
+ *
+ * ```ts
+ * const player = Isaac.GetPlayer();
+ * const gapers = getEntities(EntityType.GAPER);
+ * const closestGaper = getClosestEntityTo(player, gapers);
+ * ```
+ */
+export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[]): T | undefined;
+/**
+ * Helper function to get all of the entities in the room or all of the entities that match a
+ * specific entity type / variant / sub-type.
+ *
+ * Due to bugs with `Isaac.FindInRadius`, this function uses `Isaac.GetRoomEntities`, which is more
+ * expensive but also more robust. (If a matching entity type is provided, then `Isaac.FindByType`
+ * will be used instead.)
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the entities in the room invisible
+ * for (const entity of getEntities()) {
+ *   entity.Visible = false;
+ * }
+ * ```
+ *
+ * @param entityType Optional. If specified, will only return NPCs that match this entity type.
+ * @param variant Optional. If specified, will only return NPCs that match this variant. Default is
+ *                -1. -1 matches every variant.
+ * @param subType Optional. If specified, will only return NPCs that match this sub-type. Default is
+ *                -1. -1 matches every sub-type.
+ * @param ignoreFriendly Optional. If set to true, it will exclude friendly NPCs from being
+ *                       returned. Default is false. Will only be taken into account if
+ *                       `matchingEntityType` is specified.
+ */
+export declare function getEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): Entity[];
+/** Helper function to return a string containing the entity's type, variant, and sub-type. */
+export declare function getEntityID(entity: Entity): string;
+/**
+ * Helper function to compare two different arrays of entities. Returns the entities that are in the
+ * second array but not in the first array.
+ */
+export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities: T[], newEntities: T[]): T[];
+/**
+ * Helper function to measure an entity's velocity to see if it is moving.
+ *
+ * @param entity The entity whose velocity to measure.
+ * @param threshold Optional. The threshold from 0 to consider to be moving. Default is 0.01.
+ */
+export declare function isEntityMoving(entity: Entity, threshold?: number): boolean;
+/**
+ * Helper function to determine if the specified entity type is an end-game story boss, like Isaac,
+ * Blue Baby, Mega Satan, The Beast, and so on. This is useful because certain effects should only
+ * apply to non-story bosses, like Vanishing Twin. Also see the `STORY_BOSSES` constant.
+ */
+export declare function isStoryBoss(entityType: EntityType): boolean;
+/**
+ * Helper function to parse a string that contains an entity type, a variant, and a sub-type,
+ * separated by periods.
+ *
+ * For example, passing "45.0.1" would return an array of [45, 0, 1].
+ *
+ * Returns undefined if the string cannot be parsed.
+ */
+export declare function parseEntityID(entityID: string): [entityType: EntityType, variant: int, subType: int] | undefined;
+/**
+ * Helper function to parse a string that contains an entity type and a variant separated by a
+ * period.
+ *
+ * For example, passing "45.0" would return an array of [45, 0].
+ *
+ * Returns undefined if the string cannot be parsed.
+ */
+export declare function parseEntityTypeVariantString(entityTypeVariantString: string): [entityType: EntityType, variant: int] | undefined;
+/**
+ * Helper function to remove all of the matching entities in the room.
+ *
+ * @param entityType The entity type to match.
+ * @param entityVariant Optional. The variant to match. Default is -1. -1 matches every variant.
+ * @param entitySubType Optional. The sub-type to match. Default is -1. -1 matches every sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of collectibles.
+ * @returns True if one or more entities were removed, false otherwise.
+ */
+export declare function removeAllMatchingEntities(entityType: EntityType, entityVariant?: number, entitySubType?: number, cap?: int | undefined): boolean;
+/**
+ * Helper function to remove all of the entities in the supplied array.
+ *
+ * @param entities The array of entities to remove.
+ * @param cap Optional. If specified, will only remove the given amount of entities.
+ * @returns True if one or more entities were removed, false otherwise.
+ */
+export declare function removeEntities(entities: Entity[], cap?: int): boolean;
+/**
+ * Helper function to reroll an enemy. Use this instead of the vanilla "Game.RerollEnemy" function
+ * if you want the rerolled enemy to be returned.
+ *
+ * @param entity The entity to reroll.
+ * @returns If the game failed to reroll the enemy, returns undefined. Otherwise, returns the
+ *          rerolled entity.
+ */
+export declare function rerollEnemy(entity: Entity): Entity | undefined;
+export declare function setEntityRandomColor(entity: Entity): void;
+/**
+ * Helper function to spawn an entity. Use this instead of the `Isaac.Spawn` method if you do not
+ * need to specify the velocity or spawner.
+ *
+ * Also see the `spawnWithSeed` helper function.
+ */
+export declare function spawn(entityType: EntityType, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): Entity;
+/**
+ * Helper function to spawn an entity. Use this instead of the `Game.Spawn` method if you do not
+ * need to specify the velocity or spawner.
+ */
+export declare function spawnWithSeed(entityType: EntityType, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): Entity;

package/functions/entity.lua

@@ -0,0 +1,233 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__StringSplit = ____lualib.__TS__StringSplit
+local ____exports = {}
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____storyBossesSet = require("sets.storyBossesSet")
+local STORY_BOSSES_SET = ____storyBossesSet.STORY_BOSSES_SET
+local ____random = require("functions.random")
+local getRandom = ____random.getRandom
+local ____rng = require("functions.rng")
+local newRNG = ____rng.newRNG
+function ____exports.removeEntities(self, entities, cap)
+    if #entities == 0 then
+        return false
+    end
+    local numEntitiesRemoved = 0
+    for ____, entity in ipairs(entities) do
+        entity:Remove()
+        numEntitiesRemoved = numEntitiesRemoved + 1
+        if cap ~= nil and numEntitiesRemoved >= cap then
+            return true
+        end
+    end
+    return true
+end
+function ____exports.countEntities(self, entityType, variant, subType, ignoreFriendly)
+    if entityType == nil then
+        entityType = -1
+    end
+    if variant == nil then
+        variant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
+    end
+    if not ignoreFriendly then
+        return Isaac.CountEntities(nil, entityType, variant, subType)
+    end
+    local entities = Isaac.FindByType(
+        entityType,
+        variant,
+        subType,
+        false,
+        ignoreFriendly
+    )
+    return #entities
+end
+function ____exports.getClosestEntityTo(self, referenceEntity, entities)
+    local closestEntity
+    local closestDistance = math.huge
+    for ____, entity in ipairs(entities) do
+        local distance = referenceEntity.Position:Distance(entity.Position)
+        if distance < closestDistance then
+            closestEntity = entity
+            closestDistance = distance
+        end
+    end
+    return closestEntity
+end
+function ____exports.getEntities(self, entityType, variant, subType, ignoreFriendly)
+    if variant == nil then
+        variant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
+    end
+    if entityType == nil then
+        return Isaac.GetRoomEntities()
+    end
+    return Isaac.FindByType(entityType, variant, subType, ignoreFriendly)
+end
+function ____exports.getEntityID(self, entity)
+    return (((tostring(entity.Type) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType)
+end
+function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
+    local oldEntitiesSet = __TS__New(Set)
+    for ____, entity in ipairs(oldEntities) do
+        local ptrHash = GetPtrHash(entity)
+        oldEntitiesSet:add(ptrHash)
+    end
+    return __TS__ArrayFilter(
+        newEntities,
+        function(____, entity)
+            local ptrHash = GetPtrHash(entity)
+            return not oldEntitiesSet:has(ptrHash)
+        end
+    )
+end
+function ____exports.isEntityMoving(self, entity, threshold)
+    if threshold == nil then
+        threshold = 0.01
+    end
+    return entity.Velocity:Length() >= threshold
+end
+function ____exports.isStoryBoss(self, entityType)
+    return STORY_BOSSES_SET:has(entityType)
+end
+function ____exports.parseEntityID(self, entityID)
+    local entityIDArray = __TS__StringSplit(entityID, ".")
+    if #entityIDArray ~= 3 then
+        return nil
+    end
+    local entityTypeString, variantString, subTypeString = table.unpack(entityIDArray)
+    local entityType = tonumber(entityTypeString)
+    if entityType == nil then
+        return nil
+    end
+    local variant = tonumber(variantString)
+    if variant == nil then
+        return nil
+    end
+    local subType = tonumber(subTypeString)
+    if subType == nil then
+        return nil
+    end
+    return {entityType, variant, subType}
+end
+function ____exports.parseEntityTypeVariantString(self, entityTypeVariantString)
+    local entityTypeVariantArray = __TS__StringSplit(entityTypeVariantString, ".")
+    if #entityTypeVariantArray ~= 2 then
+        return nil
+    end
+    local entityTypeString, variantString = table.unpack(entityTypeVariantArray)
+    local entityType = tonumber(entityTypeString)
+    if entityType == nil then
+        return nil
+    end
+    local variant = tonumber(variantString)
+    if variant == nil then
+        return nil
+    end
+    return {entityType, variant}
+end
+function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)
+    if entityVariant == nil then
+        entityVariant = -1
+    end
+    if entitySubType == nil then
+        entitySubType = -1
+    end
+    if cap == nil then
+        cap = nil
+    end
+    local entities = ____exports.getEntities(nil, entityType, entityVariant, entitySubType)
+    return ____exports.removeEntities(nil, entities, cap)
+end
+function ____exports.rerollEnemy(self, entity)
+    local oldEntities = ____exports.getEntities(nil)
+    local wasRerolled = game:RerollEnemy(entity)
+    if not wasRerolled then
+        return nil
+    end
+    local newEntities = ____exports.getEntities(nil)
+    local filteredNewEntities = ____exports.getFilteredNewEntities(nil, oldEntities, newEntities)
+    if #filteredNewEntities == 0 then
+        error("Failed to find the new entity generated by the \"Game.RerollEnemy\" method.")
+    end
+    return filteredNewEntities[1]
+end
+function ____exports.setEntityRandomColor(self, entity)
+    local rng = newRNG(nil, entity.InitSeed)
+    local r = getRandom(nil, rng)
+    local g = getRandom(nil, rng)
+    local b = getRandom(nil, rng)
+    local color = Color(r, g, b)
+    entity:SetColor(
+        color,
+        100000,
+        100000,
+        false,
+        false
+    )
+end
+function ____exports.spawn(self, entityType, variant, 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
+    if seed == nil then
+        return Isaac.Spawn(
+            entityType,
+            variant,
+            subType,
+            position,
+            velocity,
+            spawner
+        )
+    end
+    return game:Spawn(
+        entityType,
+        variant,
+        position,
+        velocity,
+        spawner,
+        subType,
+        seed
+    )
+end
+function ____exports.spawnWithSeed(self, entityType, variant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawn(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+return ____exports