isaacscript-common 2.3.0 → 3.0.0

package/functions/entity.lua

@@ -0,0 +1,321 @@
+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
+--- 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.
+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
+--- 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.
+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
+--- 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);
+-- ```
+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
+--- 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.
+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
+--- Helper function to return a string containing the entity's type, variant, and sub-type.
+function ____exports.getEntityID(self, entity)
+    return (((tostring(entity.Type) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType)
+end
+--- Helper function to compare two different arrays of entities. Returns the entities that are in the
+-- second array but not in the first array.
+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
+--- 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.
+function ____exports.isEntityMoving(self, entity, threshold)
+    if threshold == nil then
+        threshold = 0.01
+    end
+    return entity.Velocity:Length() >= threshold
+end
+--- 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.
+function ____exports.isStoryBoss(self, entityType)
+    return STORY_BOSSES_SET:has(entityType)
+end
+--- 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.
+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
+--- 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.
+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
+--- 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.
+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
+--- 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.
+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
+--- 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.
+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
+--- 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.
+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

package/functions/entitySpecific.d.ts

@@ -0,0 +1,264 @@
+import { BombVariant, EffectVariant, EntityType, FamiliarVariant, KnifeVariant, LaserVariant, PickupVariant, ProjectilesMode, ProjectileVariant, SlotVariant, TearVariant } from "isaac-typescript-definitions";
+/**
+ * Helper function to get all of the `EntityType.BOMB` in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the bombs in the room invisible
+ * for (const bomb of getBombs()) {
+ *   bomb.Visible = false;
+ * }
+ * ```
+ */
+export declare function getBombs(bombVariant?: BombVariant, subType?: number): EntityBomb[];
+/**
+ * Helper function to get all of the `EntityType.EFFECT` in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the effects in the room invisible
+ * for (const effect of getEffects()) {
+ *   effect.Visible = false;
+ * }
+ * ```
+ */
+export declare function getEffects(effectVariant?: EffectVariant, subType?: number): EntityEffect[];
+/**
+ * Helper function to get all of the familiars in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the familiars in the room invisible
+ * for (const familiar of getFamiliars()) {
+ *   familiar.Visible = false;
+ * }
+ * ```
+ */
+export declare function getFamiliars(familiarVariant?: FamiliarVariant, subType?: number): EntityFamiliar[];
+/**
+ * Helper function to get all of the `EntityType.KNIFE` in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the knives in the room invisible
+ * for (const knife of getKnives()) {
+ *   knife.Visible = false;
+ * }
+ * ```
+ */
+export declare function getKnives(knifeVariant?: KnifeVariant, subType?: number): EntityKnife[];
+/**
+ * Helper function to get all of the `EntityType.LASER` in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the lasers in the room invisible
+ * for (const laser of getLasers()) {
+ *   laser.Visible = false;
+ * }
+ * ```
+ */
+export declare function getLasers(laserVariant?: LaserVariant, subType?: number): EntityLaser[];
+/** The same thing as the `getEntities` function, but returns only NPCs. */
+export declare function getNPCs(entityType?: EntityType, variant?: int, subType?: int, ignoreFriendly?: boolean): EntityNPC[];
+/**
+ * Helper function to get all of the pickups in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the pickups in the room invisible
+ * for (const pickup of getPickups()) {
+ *   pickup.Visible = false;
+ * }
+ * ```
+ */
+export declare function getPickups(pickupVariant?: PickupVariant, subType?: number): EntityPickup[];
+/**
+ * Helper function to get all of the `EntityType.PROJECTILE` in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the projectiles in the room invisible
+ * for (const projectile of getProjectiles()) {
+ *   projectile.Visible = false;
+ * }
+ * ```
+ */
+export declare function getProjectiles(projectileVariant?: ProjectileVariant, subType?: number): EntityProjectile[];
+/**
+ * Helper function to get all of the `EntityType.SLOT` in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the slots in the room invisible
+ * for (const slot of getSlots()) {
+ *   slot.Visible = false;
+ * }
+ * ```
+ */
+export declare function getSlots(slotVariant?: SlotVariant, subType?: number): EntitySlot[];
+/**
+ * Helper function to get all of the `EntityType.TEAR` in the room.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Make all of the tears in the room invisible
+ * for (const tear of getTears()) {
+ *   tear.Visible = false;
+ * }
+ * ```
+ */
+export declare function getTears(tearVariant?: TearVariant, subType?: number): EntityTear[];
+/**
+ * The base game `EntityNPC.FireProjectiles` method does not return anything, which is a problem in
+ * situations where you need to work with the fired projectiles. This function invokes that method,
+ * and then returns the projectiles that were spawned.
+ *
+ * @param npc The EntityNPC firing projectiles.
+ * @param position The starting position of the projectiles.
+ * @param velocity The starting velocity of the projectiles.
+ * @param projectilesMode A ProjectilesMode enum value defining how to fire the projectiles.
+ * @param projectileParams A ProjectileParams object containing various parameters for the
+ *                         projectiles.
+ * @returns An array of EntityProjectiles containing all fired projectiles.
+ */
+export declare function npcFireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode: ProjectilesMode, projectileParams: ProjectileParams): EntityProjectile[];
+/**
+ * Helper function to remove all of the `EntityType.BOMB` in the room.
+ *
+ * @param bombVariant Optional. If specified, will only remove bombs that match this variant.
+ * @param subType Optional. If specified, will only remove bombs that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of bombs.
+ * @returns True if one or more bombs were removed, false otherwise.
+ */
+export declare function removeAllBombs(bombVariant?: BombVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the effects in the room.
+ *
+ * @param effectVariant Optional. If specified, will only remove effects that match this variant.
+ * @param subType Optional. If specified, will only remove effects that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of effects.
+ * @returns True if one or more effects were removed, false otherwise.
+ */
+export declare function removeAllEffects(effectVariant?: EffectVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the familiars in the room.
+ *
+ * @param familiarVariant Optional. If specified, will only remove familiars that match this
+ *                        variant.
+ * @param subType Optional. If specified, will only remove familiars that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of familiars.
+ * @returns True if one or more familiars were removed, false otherwise.
+ */
+export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the `EntityType.KNIFE` in the room.
+ *
+ * @param knifeVariant Optional. If specified, will only remove knives that match this variant.
+ * @param subType Optional. If specified, will only remove knives that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of knives.
+ * @returns True if one or more knives were removed, false otherwise.
+ */
+export declare function removeAllKnives(knifeVariant?: KnifeVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the `EntityType.LASER` in the room.
+ *
+ * @param laserVariant Optional. If specified, will only remove lasers that match this variant.
+ * @param subType Optional. If specified, will only remove lasers that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of lasers.
+ * @returns True if one or more lasers were removed, false otherwise.
+ */
+export declare function removeAllLasers(laserVariant?: LaserVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all NPCs in the room.
+ *
+ * @param cap Optional. If specified, will only remove the given amount of NPCs.
+ * @returns True if one or more NPCs were removed, false otherwise.
+ */
+export declare function removeAllNPCs(cap?: int): boolean;
+/**
+ * Helper function to remove all of the pickups in the room.
+ *
+ * @param pickupVariant Optional. If specified, will only remove pickups that match this variant.
+ * @param subType Optional. If specified, will only remove pickups that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of pickups.
+ * @returns True if one or more pickups were removed, false otherwise.
+ */
+export declare function removeAllPickups(pickupVariant?: PickupVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the `EntityType.PROJECTILE` in the room.
+ *
+ * @param projectileVariant Optional. If specified, will only remove projectiles that match this
+ *                          variant.
+ * @param subType Optional. If specified, will only remove projectiles that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of projectiles.
+ * @returns True if one or more projectiles were removed, false otherwise.
+ */
+export declare function removeAllProjectiles(projectileVariant?: ProjectileVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the `EntityType.SLOT` in the room.
+ *
+ * @param slotVariant Optional. If specified, will only remove slots that match this variant.
+ * @param subType Optional. If specified, will only remove slots that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of slots.
+ * @returns True if one or more slots were removed, false otherwise.
+ */
+export declare function removeAllSlots(slotVariant?: SlotVariant, subType?: int, cap?: int): boolean;
+/**
+ * Helper function to remove all of the `EntityType.TEAR` in the room.
+ *
+ * @param tearVariant Optional. If specified, will only remove tears that match this variant.
+ * @param subType Optional. If specified, will only remove tears that match this sub-type.
+ * @param cap Optional. If specified, will only remove the given amount of tears.
+ * @returns True if one or more tears were removed, false otherwise.
+ */
+export declare function removeAllTears(tearVariant?: TearVariant, subType?: int, cap?: int): boolean;
+/** Helper function to spawn a `EntityType.BOMB` (4). */
+export declare function spawnBomb(bombVariant: BombVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
+/** Helper function to spawn a `EntityType.BOMB` (4) with a specific seed. */
+export declare function spawnBombWithSeed(bombVariant: BombVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
+/** Helper function to spawn a `EntityType.EFFECT` (1000). */
+export declare function spawnEffect(effectVariant: EffectVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityEffect;
+/** Helper function to spawn a `EntityType.EFFECT` (1000) with a specific seed. */
+export declare function spawnEffectWithSeed(effectVariant: EffectVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
+/** Helper function to spawn a `EntityType.FAMILIAR` (3). */
+export declare function spawnFamiliar(familiarVariant: FamiliarVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityFamiliar;
+/** Helper function to spawn a `EntityType.FAMILIAR` (3) with a specific seed. */
+export declare function spawnFamiliarWithSeed(familiarVariant: FamiliarVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
+/** Helper function to spawn a `EntityType.KNIFE` (8). */
+export declare function spawnKnife(knifeVariant: KnifeVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityKnife;
+/** Helper function to spawn a `EntityType.KNIFE` (8) with a specific seed. */
+export declare function spawnKnifeWithSeed(knifeVariant: KnifeVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
+/** Helper function to spawn a `EntityType.LASER` (7). */
+export declare function spawnLaser(laserVariant: LaserVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
+/** Helper function to spawn a `EntityType.LASER` (7) with a specific seed. */
+export declare function spawnLaserWithSeed(laserVariant: LaserVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
+/** Helper function to spawn an NPC. */
+export declare function spawnNPC(entityType: EntityType, variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityNPC;
+/** Helper function to spawn an NPC with a specific seed. */
+export declare function spawnNPCWithSeed(entityType: EntityType, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityNPC;
+/** Helper function to spawn a `EntityType.PICKUP` (5). */
+export declare function spawnPickup(pickupVariant: PickupVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+/** Helper function to spawn a `EntityType.PICKUP` (5) with a specific seed. */
+export declare function spawnPickupWithSeed(pickupVariant: PickupVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+/** Helper function to spawn a `EntityType.PROJECTILE` (9). */
+export declare function spawnProjectile(projectileVariant: ProjectileVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityProjectile;
+/** Helper function to spawn a `EntityType.PROJECTILE` (9) with a specific seed. */
+export declare function spawnProjectileWithSeed(projectileVariant: ProjectileVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
+/** Helper function to spawn a `EntityType.SLOT` (6). */
+export declare function spawnSlot(slotVariant: SlotVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): Entity;
+/** Helper function to spawn a `EntityType.SLOT` (6) with a specific seed. */
+export declare function spawnSlotWithSeed(slotVariant: SlotVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): Entity;
+/** Helper function to spawn a `EntityType.TEAR` (2). */
+export declare function spawnTear(tearVariant: TearVariant, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityTear;
+/** Helper function to spawn a `EntityType.EntityType` (2) with a specific seed. */
+export declare function spawnTearWithSeed(tearVariant: TearVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;