isaacscript-common 2.3.2 → 3.0.0

package/functions/entity.lua

@@ -14,6 +14,11 @@ 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
@@ -28,6 +33,14 @@ function ____exports.removeEntities(self, entities, cap)
     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
@@ -53,6 +66,16 @@ function ____exports.countEntities(self, entityType, variant, subType, ignoreFri
     )
     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
@@ -65,6 +88,30 @@ function ____exports.getClosestEntityTo(self, referenceEntity, entities)
     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
@@ -80,9 +127,12 @@ function ____exports.getEntities(self, entityType, variant, subType, ignoreFrien
     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
@@ -97,15 +147,28 @@ function ____exports.getFilteredNewEntities(self, oldEntities, newEntities)
         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
@@ -126,6 +189,12 @@ function ____exports.parseEntityID(self, entityID)
     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
@@ -142,6 +211,13 @@ function ____exports.parseEntityTypeVariantString(self, entityTypeVariantString)
     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
@@ -155,6 +231,12 @@ function ____exports.removeAllMatchingEntities(self, entityType, entityVariant,
     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)
@@ -182,6 +264,10 @@ function ____exports.setEntityRandomColor(self, entity)
         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
@@ -212,6 +298,8 @@ function ____exports.spawn(self, entityType, variant, subType, position, velocit
         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

package/functions/entitySpecific.lua

@@ -8,6 +8,16 @@ 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
@@ -25,6 +35,16 @@ function ____exports.getBombs(self, bombVariant, subType)
     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
@@ -42,6 +62,16 @@ function ____exports.getEffects(self, effectVariant, subType)
     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
@@ -59,6 +89,16 @@ function ____exports.getFamiliars(self, familiarVariant, subType)
     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
@@ -76,6 +116,16 @@ function ____exports.getKnives(self, knifeVariant, subType)
     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
@@ -93,6 +143,7 @@ function ____exports.getLasers(self, laserVariant, subType)
     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
@@ -113,6 +164,16 @@ function ____exports.getNPCs(self, entityType, variant, subType, ignoreFriendly)
     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
@@ -130,6 +191,16 @@ function ____exports.getPickups(self, pickupVariant, subType)
     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
@@ -147,6 +218,16 @@ function ____exports.getProjectiles(self, projectileVariant, subType)
     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
@@ -157,6 +238,16 @@ function ____exports.getSlots(self, slotVariant, subType)
     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
@@ -174,6 +265,17 @@ function ____exports.getTears(self, tearVariant, subType)
     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)
@@ -181,46 +283,107 @@ function ____exports.npcFireProjectiles(self, npc, position, velocity, projectil
     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
@@ -247,6 +410,7 @@ function ____exports.spawnBomb(self, bombVariant, subType, position, velocity, s
     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
@@ -264,6 +428,7 @@ function ____exports.spawnBombWithSeed(self, bombVariant, subType, position, see
         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
@@ -290,6 +455,7 @@ function ____exports.spawnEffect(self, effectVariant, subType, position, velocit
     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
@@ -307,6 +473,7 @@ function ____exports.spawnEffectWithSeed(self, effectVariant, subType, position,
         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
@@ -333,6 +500,7 @@ function ____exports.spawnFamiliar(self, familiarVariant, subType, position, vel
     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
@@ -350,6 +518,7 @@ function ____exports.spawnFamiliarWithSeed(self, familiarVariant, subType, posit
         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
@@ -376,6 +545,7 @@ function ____exports.spawnKnife(self, knifeVariant, subType, position, velocity,
     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
@@ -393,6 +563,7 @@ function ____exports.spawnKnifeWithSeed(self, knifeVariant, subType, position, s
         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
@@ -419,6 +590,7 @@ function ____exports.spawnLaser(self, laserVariant, subType, position, velocity,
     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
@@ -436,6 +608,7 @@ function ____exports.spawnLaserWithSeed(self, laserVariant, subType, position, s
         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
@@ -462,6 +635,7 @@ function ____exports.spawnNPC(self, entityType, variant, subType, position, velo
     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
@@ -480,6 +654,7 @@ function ____exports.spawnNPCWithSeed(self, entityType, variant, subType, positi
         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
@@ -506,6 +681,7 @@ function ____exports.spawnPickup(self, pickupVariant, subType, position, velocit
     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
@@ -523,6 +699,7 @@ function ____exports.spawnPickupWithSeed(self, pickupVariant, subType, position,
         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
@@ -549,6 +726,7 @@ function ____exports.spawnProjectile(self, projectileVariant, subType, position,
     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
@@ -566,6 +744,7 @@ function ____exports.spawnProjectileWithSeed(self, projectileVariant, subType, p
         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
@@ -587,6 +766,7 @@ function ____exports.spawnSlot(self, slotVariant, subType, position, velocity, s
         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
@@ -604,6 +784,7 @@ function ____exports.spawnSlotWithSeed(self, slotVariant, subType, position, see
         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
@@ -630,6 +811,7 @@ function ____exports.spawnTear(self, tearVariant, subType, position, velocity, s
     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

package/functions/entityTypes.d.ts

@@ -1,3 +1,3 @@
 /// <reference types="isaac-typescript-definitions" />
-/** For EntityType.SLOT (6) */
+/** For `EntityType.SLOT` (6) */
 export declare function isSlot(entity: Entity): entity is EntitySlot;

package/functions/entityTypes.lua

@@ -1,6 +1,7 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+--- For `EntityType.SLOT` (6)
 function ____exports.isSlot(self, entity)
     return entity.Type == EntityType.SLOT
 end