isaacscript-common 2.3.0 → 3.0.0

package/functions/entitySpecific.lua

@@ -0,0 +1,832 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local ____entity = require("functions.entity")
+local getEntities = ____entity.getEntities
+local getFilteredNewEntities = ____entity.getFilteredNewEntities
+local removeEntities = ____entity.removeEntities
+local spawn = ____entity.spawn
+--- 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;
+-- }
+-- ```
+function ____exports.getBombs(self, bombVariant, subType)
+    if bombVariant == nil then
+        bombVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.BOMB, bombVariant, subType)
+    local bombs = {}
+    for ____, entity in ipairs(entities) do
+        local bomb = entity:ToBomb()
+        if bomb ~= nil then
+            bombs[#bombs + 1] = bomb
+        end
+    end
+    return bombs
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getEffects(self, effectVariant, subType)
+    if effectVariant == nil then
+        effectVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.EFFECT, effectVariant, subType)
+    local effects = {}
+    for ____, entity in ipairs(entities) do
+        local effect = entity:ToEffect()
+        if effect ~= nil then
+            effects[#effects + 1] = effect
+        end
+    end
+    return effects
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getFamiliars(self, familiarVariant, subType)
+    if familiarVariant == nil then
+        familiarVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.FAMILIAR, familiarVariant, subType)
+    local familiars = {}
+    for ____, entity in ipairs(entities) do
+        local familiar = entity:ToFamiliar()
+        if familiar ~= nil then
+            familiars[#familiars + 1] = familiar
+        end
+    end
+    return familiars
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getKnives(self, knifeVariant, subType)
+    if knifeVariant == nil then
+        knifeVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.KNIFE, knifeVariant, subType)
+    local knives = {}
+    for ____, entity in ipairs(entities) do
+        local knife = entity:ToKnife()
+        if knife ~= nil then
+            knives[#knives + 1] = knife
+        end
+    end
+    return knives
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getLasers(self, laserVariant, subType)
+    if laserVariant == nil then
+        laserVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.LASER, laserVariant, subType)
+    local lasers = {}
+    for ____, entity in ipairs(entities) do
+        local laser = entity:ToLaser()
+        if laser ~= nil then
+            lasers[#lasers + 1] = laser
+        end
+    end
+    return lasers
+end
+--- The same thing as the `getEntities` function, but returns only NPCs.
+function ____exports.getNPCs(self, entityType, variant, subType, ignoreFriendly)
+    if ignoreFriendly == nil then
+        ignoreFriendly = false
+    end
+    local entities = getEntities(
+        nil,
+        entityType,
+        variant,
+        subType,
+        ignoreFriendly
+    )
+    local npcs = {}
+    for ____, entity in ipairs(entities) do
+        local npc = entity:ToNPC()
+        if npc ~= nil then
+            npcs[#npcs + 1] = npc
+        end
+    end
+    return npcs
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getPickups(self, pickupVariant, subType)
+    if pickupVariant == nil then
+        pickupVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.PICKUP, pickupVariant, subType)
+    local pickups = {}
+    for ____, entity in ipairs(entities) do
+        local pickup = entity:ToPickup()
+        if pickup ~= nil then
+            pickups[#pickups + 1] = pickup
+        end
+    end
+    return pickups
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getProjectiles(self, projectileVariant, subType)
+    if projectileVariant == nil then
+        projectileVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.PROJECTILE, projectileVariant, subType)
+    local projectiles = {}
+    for ____, entity in ipairs(entities) do
+        local projectile = entity:ToProjectile()
+        if projectile ~= nil then
+            projectiles[#projectiles + 1] = projectile
+        end
+    end
+    return projectiles
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getSlots(self, slotVariant, subType)
+    if slotVariant == nil then
+        slotVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local slots = getEntities(nil, EntityType.SLOT, slotVariant, subType)
+    return slots
+end
+--- 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;
+-- }
+-- ```
+function ____exports.getTears(self, tearVariant, subType)
+    if tearVariant == nil then
+        tearVariant = -1
+    end
+    if subType == nil then
+        subType = -1
+    end
+    local entities = getEntities(nil, EntityType.TEAR, tearVariant, subType)
+    local tears = {}
+    for ____, entity in ipairs(entities) do
+        local tear = entity:ToTear()
+        if tear ~= nil then
+            tears[#tears + 1] = tear
+        end
+    end
+    return tears
+end
+--- 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.
+function ____exports.npcFireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
+    local oldEntities = ____exports.getProjectiles(nil)
+    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
+    local newEntities = ____exports.getProjectiles(nil)
+    local filteredNewEntities = getFilteredNewEntities(nil, oldEntities, newEntities)
+    return filteredNewEntities
+end
+--- 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.
+function ____exports.removeAllBombs(self, bombVariant, subType, cap)
+    local bombs = ____exports.getBombs(nil, bombVariant, subType)
+    return removeEntities(nil, bombs, cap)
+end
+--- 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.
+function ____exports.removeAllEffects(self, effectVariant, subType, cap)
+    local effects = ____exports.getEffects(nil, effectVariant, subType)
+    return removeEntities(nil, effects, cap)
+end
+--- 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.
+function ____exports.removeAllFamiliars(self, familiarVariant, subType, cap)
+    local familiars = ____exports.getFamiliars(nil, familiarVariant, subType)
+    return removeEntities(nil, familiars, cap)
+end
+--- 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.
+function ____exports.removeAllKnives(self, knifeVariant, subType, cap)
+    local knives = ____exports.getKnives(nil, knifeVariant, subType)
+    return removeEntities(nil, knives, cap)
+end
+--- 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.
+function ____exports.removeAllLasers(self, laserVariant, subType, cap)
+    local lasers = ____exports.getLasers(nil, laserVariant, subType)
+    return removeEntities(nil, lasers, cap)
+end
+--- 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.
+function ____exports.removeAllNPCs(self, cap)
+    local npcs = ____exports.getNPCs(nil)
+    return removeEntities(nil, npcs, cap)
+end
+--- 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.
+function ____exports.removeAllPickups(self, pickupVariant, subType, cap)
+    local pickups = ____exports.getPickups(nil, pickupVariant, subType)
+    return removeEntities(nil, pickups, cap)
+end
+--- 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.
+function ____exports.removeAllProjectiles(self, projectileVariant, subType, cap)
+    local projectiles = ____exports.getProjectiles(nil, projectileVariant, subType)
+    return removeEntities(nil, projectiles, cap)
+end
+--- 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.
+function ____exports.removeAllSlots(self, slotVariant, subType, cap)
+    local slots = ____exports.getSlots(nil, slotVariant, subType)
+    return removeEntities(nil, slots, cap)
+end
+--- 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.
+function ____exports.removeAllTears(self, tearVariant, subType, cap)
+    local tears = ____exports.getTears(nil, tearVariant, subType)
+    return removeEntities(nil, tears, cap)
+end
+--- Helper function to spawn a `EntityType.BOMB` (4).
+function ____exports.spawnBomb(self, bombVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.BOMB,
+        bombVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local bomb = entity:ToBomb()
+    if bomb == nil then
+        error("Failed to spawn a bomb.")
+    end
+    return bomb
+end
+--- Helper function to spawn a `EntityType.BOMB` (4) with a specific seed.
+function ____exports.spawnBombWithSeed(self, bombVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnBomb(
+        nil,
+        bombVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.EFFECT` (1000).
+function ____exports.spawnEffect(self, effectVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.EFFECT,
+        effectVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local effect = entity:ToEffect()
+    if effect == nil then
+        error("Failed to spawn an effect.")
+    end
+    return effect
+end
+--- Helper function to spawn a `EntityType.EFFECT` (1000) with a specific seed.
+function ____exports.spawnEffectWithSeed(self, effectVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnEffect(
+        nil,
+        effectVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.FAMILIAR` (3).
+function ____exports.spawnFamiliar(self, familiarVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.FAMILIAR,
+        familiarVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local familiar = entity:ToFamiliar()
+    if familiar == nil then
+        error("Failed to spawn a familiar.")
+    end
+    return familiar
+end
+--- Helper function to spawn a `EntityType.FAMILIAR` (3) with a specific seed.
+function ____exports.spawnFamiliarWithSeed(self, familiarVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnFamiliar(
+        nil,
+        familiarVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.KNIFE` (8).
+function ____exports.spawnKnife(self, knifeVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.KNIFE,
+        knifeVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local knife = entity:ToKnife()
+    if knife == nil then
+        error("Failed to spawn a knife.")
+    end
+    return knife
+end
+--- Helper function to spawn a `EntityType.KNIFE` (8) with a specific seed.
+function ____exports.spawnKnifeWithSeed(self, knifeVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnKnife(
+        nil,
+        knifeVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.LASER` (7).
+function ____exports.spawnLaser(self, laserVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.LASER,
+        laserVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local laser = entity:ToLaser()
+    if laser == nil then
+        error("Failed to spawn a laser.")
+    end
+    return laser
+end
+--- Helper function to spawn a `EntityType.LASER` (7) with a specific seed.
+function ____exports.spawnLaserWithSeed(self, laserVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnLaser(
+        nil,
+        laserVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn an NPC.
+function ____exports.spawnNPC(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
+    local entity = spawn(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local npc = entity:ToNPC()
+    if npc == nil then
+        error("Failed to spawn an NPC.")
+    end
+    return npc
+end
+--- Helper function to spawn an NPC with a specific seed.
+function ____exports.spawnNPCWithSeed(self, entityType, variant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnNPC(
+        nil,
+        entityType,
+        variant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5).
+function ____exports.spawnPickup(self, pickupVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.PICKUP,
+        pickupVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local pickup = entity:ToPickup()
+    if pickup == nil then
+        error("Failed to spawn a pickup.")
+    end
+    return pickup
+end
+--- Helper function to spawn a `EntityType.PICKUP` (5) with a specific seed.
+function ____exports.spawnPickupWithSeed(self, pickupVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnPickup(
+        nil,
+        pickupVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.PROJECTILE` (9).
+function ____exports.spawnProjectile(self, projectileVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.PROJECTILE,
+        projectileVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local projectile = entity:ToProjectile()
+    if projectile == nil then
+        error("Failed to spawn a projectile.")
+    end
+    return projectile
+end
+--- Helper function to spawn a `EntityType.PROJECTILE` (9) with a specific seed.
+function ____exports.spawnProjectileWithSeed(self, projectileVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnProjectile(
+        nil,
+        projectileVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.SLOT` (6).
+function ____exports.spawnSlot(self, slotVariant, 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 spawn(
+        nil,
+        EntityType.SLOT,
+        slotVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.SLOT` (6) with a specific seed.
+function ____exports.spawnSlotWithSeed(self, slotVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnSlot(
+        nil,
+        slotVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+--- Helper function to spawn a `EntityType.TEAR` (2).
+function ____exports.spawnTear(self, tearVariant, 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
+    local entity = spawn(
+        nil,
+        EntityType.TEAR,
+        tearVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+    local tear = entity:ToTear()
+    if tear == nil then
+        error("Failed to spawn a tear.")
+    end
+    return tear
+end
+--- Helper function to spawn a `EntityType.EntityType` (2) with a specific seed.
+function ____exports.spawnTearWithSeed(self, tearVariant, subType, position, seed, velocity, spawner)
+    if velocity == nil then
+        velocity = VectorZero
+    end
+    if spawner == nil then
+        spawner = nil
+    end
+    return ____exports.spawnTear(
+        nil,
+        tearVariant,
+        subType,
+        position,
+        velocity,
+        spawner,
+        seed
+    )
+end
+return ____exports