isaacscript-common 1.2.257 → 1.2.260

package/dist/functions/entity.lua

@@ -2,7 +2,6 @@ local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
-local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
@@ -56,7 +55,7 @@ function ____exports.countEntities(self, entityType, variant, subType, ignoreFri
     return #entities
 end
 function ____exports.getClosestEntityTo(self, referenceEntity, entities)
-    local closestEntity = nil
+    local closestEntity
     local closestDistance = math.huge
     for ____, entity in ipairs(entities) do
         local distance = referenceEntity.Position:Distance(entity.Position)
@@ -65,25 +64,22 @@ function ____exports.getClosestEntityTo(self, referenceEntity, entities)
             closestDistance = distance
         end
     end
-    if closestEntity == nil then
-        error("Failed to find the closest entity.")
-    end
     return closestEntity
 end
-function ____exports.getEntities(self, matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
-    if matchingVariant == nil then
-        matchingVariant = -1
+function ____exports.getEntities(self, entityType, variant, subType, ignoreFriendly)
+    if variant == nil then
+        variant = -1
     end
-    if matchingSubType == nil then
-        matchingSubType = -1
+    if subType == nil then
+        subType = -1
     end
     if ignoreFriendly == nil then
         ignoreFriendly = false
     end
-    if matchingEntityType == nil then
+    if entityType == nil then
         return Isaac.GetRoomEntities()
     end
-    return Isaac.FindByType(matchingEntityType, matchingVariant, matchingSubType, ignoreFriendly)
+    return Isaac.FindByType(entityType, variant, subType, ignoreFriendly)
 end
 function ____exports.getEntityID(self, entity)
     return (((tostring(entity.Type) .. ".") .. tostring(entity.Variant)) .. ".") .. tostring(entity.SubType)
@@ -145,7 +141,7 @@ function ____exports.setEntityRandomColor(self, entity)
         3,
         function()
             local randomColorValue = getRandom(nil, rng)
-            __TS__ArrayPush(colorValues, randomColorValue)
+            colorValues[#colorValues + 1] = randomColorValue
         end
     )
     local color = Color(colorValues[1], colorValues[2], colorValues[3])

package/dist/functions/entitySpecific.d.ts

@@ -11,7 +11,7 @@ import { EntityTypeNonNPC } from "../types/EntityTypeNonNPC";
  * }
  * ```
  */
-export declare function getBombs(matchingVariant?: BombVariant | int, matchingSubType?: number): EntityBomb[];
+export declare function getBombs(bombVariant?: BombVariant | int, subType?: number): EntityBomb[];
 /**
  * Helper function to get all of the `EntityType.ENTITY_EFFECT` in the room.
  *
@@ -23,7 +23,7 @@ export declare function getBombs(matchingVariant?: BombVariant | int, matchingSu
  * }
  * ```
  */
-export declare function getEffects(matchingVariant?: EffectVariant | int, matchingSubType?: number): EntityEffect[];
+export declare function getEffects(effectVariant?: EffectVariant | int, subType?: number): EntityEffect[];
 /**
  * Helper function to get all of the familiars in the room.
  *
@@ -35,7 +35,7 @@ export declare function getEffects(matchingVariant?: EffectVariant | int, matchi
  * }
  * ```
  */
-export declare function getFamiliars(matchingVariant?: FamiliarVariant | int, matchingSubType?: number): EntityFamiliar[];
+export declare function getFamiliars(familiarVariant?: FamiliarVariant | int, subType?: number): EntityFamiliar[];
 /**
  * Helper function to get all of the `EntityType.ENTITY_KNIFE` in the room.
  *
@@ -47,7 +47,7 @@ export declare function getFamiliars(matchingVariant?: FamiliarVariant | int, ma
  * }
  * ```
  */
-export declare function getKnives(matchingVariant?: KnifeVariant | int, matchingSubType?: number): EntityKnife[];
+export declare function getKnives(knifeVariant?: KnifeVariant | int, subType?: number): EntityKnife[];
 /**
  * Helper function to get all of the `EntityType.ENTITY_LASER` in the room.
  *
@@ -59,9 +59,9 @@ export declare function getKnives(matchingVariant?: KnifeVariant | int, matching
  * }
  * ```
  */
-export declare function getLasers(matchingVariant?: LaserVariant | int, matchingSubType?: number): EntityLaser[];
+export declare function getLasers(laserVariant?: LaserVariant | int, subType?: number): EntityLaser[];
 /** The same thing as the `getEntities` function, but returns only NPCs. */
-export declare function getNPCs(matchingEntityType?: EntityType | int, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
+export declare function getNPCs(entityType?: EntityType | int, variant?: int, subType?: int, ignoreFriendly?: boolean): EntityNPC[];
 /**
  * Helper function to get all of the pickups in the room.
  *
@@ -73,7 +73,7 @@ export declare function getNPCs(matchingEntityType?: EntityType | int, matchingV
  * }
  * ```
  */
-export declare function getPickups(matchingVariant?: PickupVariant | int, matchingSubType?: number): EntityPickup[];
+export declare function getPickups(pickupVariant?: PickupVariant | int, subType?: number): EntityPickup[];
 /**
  * Helper function to get all of the `EntityType.ENTITY_PROJECTILE` in the room.
  *
@@ -85,7 +85,7 @@ export declare function getPickups(matchingVariant?: PickupVariant | int, matchi
  * }
  * ```
  */
-export declare function getProjectiles(matchingVariant?: ProjectileVariant | int, matchingSubType?: number): EntityProjectile[];
+export declare function getProjectiles(projectileVariant?: ProjectileVariant | int, subType?: number): EntityProjectile[];
 /**
  * Helper function to get all of the `EntityType.ENTITY_SLOT` in the room.
  *
@@ -97,7 +97,7 @@ export declare function getProjectiles(matchingVariant?: ProjectileVariant | int
  * }
  * ```
  */
-export declare function getSlots(matchingVariant?: SlotVariant | int, matchingSubType?: number): Entity[];
+export declare function getSlots(slotVariant?: SlotVariant | int, subType?: number): Entity[];
 /**
  * Helper function to get all of the `EntityType.ENTITY_TEAR` in the room.
  *
@@ -109,52 +109,52 @@ export declare function getSlots(matchingVariant?: SlotVariant | int, matchingSu
  * }
  * ```
  */
-export declare function getTears(matchingVariant?: TearVariant | int, matchingSubType?: number): EntityTear[];
+export declare function getTears(tearVariant?: TearVariant | int, subType?: number): EntityTear[];
 /**
  * Helper function to remove all of the `EntityType.ENTITY_BOMB` in the room.
  *
- * @param variant Optional. If specified, will only remove bombs that match this variant.
+ * @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(variant?: BombVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllBombs(bombVariant?: BombVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the effects in the room.
  *
- * @param variant Optional. If specified, will only remove effects that match this variant.
+ * @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(variant?: EffectVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllEffects(effectVariant?: EffectVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the familiars in the room.
  *
- * @param variant Optional. If specified, will only remove familiars that match this variant.
+ * @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(variant?: FamiliarVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.ENTITY_KNIFE` in the room.
  *
- * @param variant Optional. If specified, will only remove knives that match this variant.
+ * @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(variant?: KnifeVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllKnives(knifeVariant?: KnifeVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.ENTITY_LASER` in the room.
  *
- * @param variant Optional. If specified, will only remove lasers that match this variant.
+ * @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(variant?: LaserVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllLasers(laserVariant?: LaserVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all NPCs in the room.
  *
@@ -165,76 +165,76 @@ export declare function removeAllNPCs(cap?: int): boolean;
 /**
  * Helper function to remove all of the pickups in the room.
  *
- * @param variant Optional. If specified, will only remove pickups that match this variant.
+ * @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(variant?: PickupVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllPickups(pickupVariant?: PickupVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.ENTITY_PROJECTILE` in the room.
  *
- * @param variant Optional. If specified, will only remove projectiles that match this variant.
+ * @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(variant?: ProjectileVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllProjectiles(projectileVariant?: ProjectileVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.ENTITY_SLOT` in the room.
  *
- * @param variant Optional. If specified, will only remove slots that match this variant.
+ * @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(variant?: SlotVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllSlots(slotVariant?: SlotVariant | int, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.ENTITY_TEAR` in the room.
  *
- * @param variant Optional. If specified, will only remove tears that match this variant.
+ * @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(variant?: TearVariant | int, subType?: int, cap?: int): boolean;
+export declare function removeAllTears(tearVariant?: TearVariant | int, subType?: int, cap?: int): boolean;
 /** Helper function to spawn a `EntityType.ENTITY_BOMB` (4). */
-export declare function spawnBomb(variant: BombVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
+export declare function spawnBomb(bombVariant: BombVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
 /** Helper function to spawn a `EntityType.ENTITY_BOMB` (4) with a specific seed. */
-export declare function spawnBombWithSeed(variant: BombVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
+export declare function spawnBombWithSeed(bombVariant: BombVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
 /** Helper function to spawn a `EntityType.ENTITY_EFFECT` (1000). */
-export declare function spawnEffect(variant: EffectVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityEffect;
+export declare function spawnEffect(effectVariant: EffectVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityEffect;
 /** Helper function to spawn a `EntityType.ENTITY_EFFECT` (1000) with a specific seed. */
-export declare function spawnEffectWithSeed(variant: EffectVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
+export declare function spawnEffectWithSeed(effectVariant: EffectVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
 /** Helper function to spawn a `EntityType.ENTITY_FAMILIAR` (3). */
-export declare function spawnFamiliar(variant: FamiliarVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityFamiliar;
+export declare function spawnFamiliar(familiarVariant: FamiliarVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityFamiliar;
 /** Helper function to spawn a `EntityType.ENTITY_FAMILIAR` (3) with a specific seed. */
-export declare function spawnFamiliarWithSeed(variant: FamiliarVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
+export declare function spawnFamiliarWithSeed(familiarVariant: FamiliarVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
 /** Helper function to spawn a `EntityType.ENTITY_KNIFE` (8). */
-export declare function spawnKnife(variant: KnifeVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityKnife;
+export declare function spawnKnife(knifeVariant: KnifeVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityKnife;
 /** Helper function to spawn a `EntityType.ENTITY_KNIFE` (8) with a specific seed. */
-export declare function spawnKnifeWithSeed(variant: KnifeVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
+export declare function spawnKnifeWithSeed(knifeVariant: KnifeVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
 /** Helper function to spawn a `EntityType.ENTITY_LASER` (7). */
-export declare function spawnLaser(variant: LaserVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
+export declare function spawnLaser(laserVariant: LaserVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
 /** Helper function to spawn a `EntityType.ENTITY_LASER` (7) with a specific seed. */
-export declare function spawnLaserWithSeed(variant: LaserVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
+export declare function spawnLaserWithSeed(laserVariant: LaserVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
 /** Helper function to spawn an NPC. */
 export declare function spawnNPC<T extends number>(entityType: T extends EntityTypeNonNPC ? never : T, 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 | int, variant: int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityNPC;
 /** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5). */
-export declare function spawnPickup(variant: PickupVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+export declare function spawnPickup(pickupVariant: PickupVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.ENTITY_PICKUP` (5) with a specific seed. */
-export declare function spawnPickupWithSeed(variant: PickupVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+export declare function spawnPickupWithSeed(pickupVariant: PickupVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
 /** Helper function to spawn a `EntityType.ENTITY_PROJECTILE` (9). */
-export declare function spawnProjectile(variant: ProjectileVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityProjectile;
+export declare function spawnProjectile(projectileVariant: ProjectileVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityProjectile;
 /** Helper function to spawn a `EntityType.ENTITY_PROJECTILE` (9) with a specific seed. */
-export declare function spawnProjectileWithSeed(variant: ProjectileVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
+export declare function spawnProjectileWithSeed(projectileVariant: ProjectileVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
 /** Helper function to spawn a `EntityType.ENTITY_SLOT` (6). */
-export declare function spawnSlot(variant: SlotVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): Entity;
+export declare function spawnSlot(slotVariant: SlotVariant | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): Entity;
 /** Helper function to spawn a `EntityType.ENTITY_SLOT` (6) with a specific seed. */
-export declare function spawnSlotWithSeed(variant: int | SlotVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): Entity;
+export declare function spawnSlotWithSeed(slotVariant: int | SlotVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): Entity;
 /** Helper function to spawn a `EntityType.ENTITY_TEAR` (2). */
-export declare function spawnTear(variant: int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityTear;
+export declare function spawnTear(tearVariant: TearVariant | int, 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(variant: TearVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;
+export declare function spawnTearWithSeed(tearVariant: TearVariant | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;