isaacscript-common 2.0.11 → 2.0.14

package/dist/functions/entitySpecific.d.ts

@@ -3,7 +3,8 @@ import { EntityTypeNonNPC } from "../types/EntityTypeNonNPC";
 /**
  * Helper function to get all of the `EntityType.BOMB` in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the bombs in the room invisible
  * for (const bomb of getBombs()) {
@@ -11,11 +12,12 @@ import { EntityTypeNonNPC } from "../types/EntityTypeNonNPC";
  * }
  * ```
  */
-export declare function getBombs(bombVariant?: BombVariant | int, subType?: number): EntityBomb[];
+export declare function getBombs(bombVariant?: BombVariant, subType?: number): EntityBomb[];
 /**
  * Helper function to get all of the `EntityType.EFFECT` in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the effects in the room invisible
  * for (const effect of getEffects()) {
@@ -23,11 +25,12 @@ export declare function getBombs(bombVariant?: BombVariant | int, subType?: numb
  * }
  * ```
  */
-export declare function getEffects(effectVariant?: EffectVariant | int, subType?: number): EntityEffect[];
+export declare function getEffects(effectVariant?: EffectVariant, subType?: number): EntityEffect[];
 /**
  * Helper function to get all of the familiars in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the familiars in the room invisible
  * for (const familiar of getFamiliars()) {
@@ -35,11 +38,12 @@ export declare function getEffects(effectVariant?: EffectVariant | int, subType?
  * }
  * ```
  */
-export declare function getFamiliars(familiarVariant?: FamiliarVariant | int, subType?: number): EntityFamiliar[];
+export declare function getFamiliars(familiarVariant?: FamiliarVariant, subType?: number): EntityFamiliar[];
 /**
  * Helper function to get all of the `EntityType.KNIFE` in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the knives in the room invisible
  * for (const knife of getKnives()) {
@@ -47,11 +51,12 @@ export declare function getFamiliars(familiarVariant?: FamiliarVariant | int, su
  * }
  * ```
  */
-export declare function getKnives(knifeVariant?: KnifeVariant | int, subType?: number): EntityKnife[];
+export declare function getKnives(knifeVariant?: KnifeVariant, subType?: number): EntityKnife[];
 /**
  * Helper function to get all of the `EntityType.LASER` in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the lasers in the room invisible
  * for (const laser of getLasers()) {
@@ -59,13 +64,14 @@ export declare function getKnives(knifeVariant?: KnifeVariant | int, subType?: n
  * }
  * ```
  */
-export declare function getLasers(laserVariant?: LaserVariant | int, subType?: number): EntityLaser[];
+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 | int, variant?: int, subType?: int, ignoreFriendly?: boolean): EntityNPC[];
+export declare function getNPCs(entityType?: EntityType, variant?: int, subType?: int, ignoreFriendly?: boolean): EntityNPC[];
 /**
  * Helper function to get all of the pickups in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the pickups in the room invisible
  * for (const pickup of getPickups()) {
@@ -73,11 +79,12 @@ export declare function getNPCs(entityType?: EntityType | int, variant?: int, su
  * }
  * ```
  */
-export declare function getPickups(pickupVariant?: PickupVariant | int, subType?: number): EntityPickup[];
+export declare function getPickups(pickupVariant?: PickupVariant, subType?: number): EntityPickup[];
 /**
  * Helper function to get all of the `EntityType.PROJECTILE` in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the projectiles in the room invisible
  * for (const projectile of getProjectiles()) {
@@ -85,11 +92,12 @@ export declare function getPickups(pickupVariant?: PickupVariant | int, subType?
  * }
  * ```
  */
-export declare function getProjectiles(projectileVariant?: ProjectileVariant | int, subType?: number): EntityProjectile[];
+export declare function getProjectiles(projectileVariant?: ProjectileVariant, subType?: number): EntityProjectile[];
 /**
  * Helper function to get all of the `EntityType.SLOT` in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the slots in the room invisible
  * for (const slot of getSlots()) {
@@ -97,11 +105,12 @@ export declare function getProjectiles(projectileVariant?: ProjectileVariant | i
  * }
  * ```
  */
-export declare function getSlots(slotVariant?: SlotVariant | int, subType?: number): Entity[];
+export declare function getSlots(slotVariant?: SlotVariant, subType?: number): Entity[];
 /**
  * Helper function to get all of the `EntityType.TEAR` in the room.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the tears in the room invisible
  * for (const tear of getTears()) {
@@ -109,7 +118,7 @@ export declare function getSlots(slotVariant?: SlotVariant | int, subType?: numb
  * }
  * ```
  */
-export declare function getTears(tearVariant?: TearVariant | int, subType?: number): EntityTear[];
+export declare function getTears(tearVariant?: TearVariant, subType?: number): EntityTear[];
 /**
  * Helper function to remove all of the `EntityType.BOMB` in the room.
  *
@@ -118,7 +127,7 @@ export declare function getTears(tearVariant?: TearVariant | int, subType?: numb
  * @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 | int, subType?: int, cap?: int): boolean;
+export declare function removeAllBombs(bombVariant?: BombVariant, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the effects in the room.
  *
@@ -127,17 +136,17 @@ export declare function removeAllBombs(bombVariant?: BombVariant | int, subType?
  * @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 | int, subType?: int, cap?: int): boolean;
+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.
+ *                        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 | int, subType?: int, cap?: int): boolean;
+export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.KNIFE` in the room.
  *
@@ -146,7 +155,7 @@ export declare function removeAllFamiliars(familiarVariant?: FamiliarVariant | i
  * @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 | int, subType?: int, cap?: int): boolean;
+export declare function removeAllKnives(knifeVariant?: KnifeVariant, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.LASER` in the room.
  *
@@ -155,7 +164,7 @@ export declare function removeAllKnives(knifeVariant?: KnifeVariant | int, subTy
  * @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 | int, subType?: int, cap?: int): boolean;
+export declare function removeAllLasers(laserVariant?: LaserVariant, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all NPCs in the room.
  *
@@ -171,17 +180,17 @@ export declare function removeAllNPCs(cap?: int): boolean;
  * @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 | int, subType?: int, cap?: int): boolean;
+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.
+ *                          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 | int, subType?: int, cap?: int): boolean;
+export declare function removeAllProjectiles(projectileVariant?: ProjectileVariant, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.SLOT` in the room.
  *
@@ -190,7 +199,7 @@ export declare function removeAllProjectiles(projectileVariant?: ProjectileVaria
  * @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 | int, subType?: int, cap?: int): boolean;
+export declare function removeAllSlots(slotVariant?: SlotVariant, subType?: int, cap?: int): boolean;
 /**
  * Helper function to remove all of the `EntityType.TEAR` in the room.
  *
@@ -199,44 +208,44 @@ export declare function removeAllSlots(slotVariant?: SlotVariant | int, subType?
  * @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 | int, subType?: int, cap?: int): boolean;
+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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityBomb;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityBomb;
+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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityEffect;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityEffect;
+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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityFamiliar;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityFamiliar;
+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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityKnife;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityKnife;
+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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityLaser;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityLaser;
+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<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;
+export declare function spawnNPC<T extends EntityType>(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;
+export declare function spawnNPCWithSeed<T extends EntityType>(entityType: T extends EntityTypeNonNPC ? never : T, 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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityPickup;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityPickup;
+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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityProjectile;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityProjectile;
+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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): Entity;
+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: int | 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 | int, subType: int, position: Vector, velocity?: Readonly<Vector>, spawner?: Entity | undefined, seed?: Seed | undefined): EntityTear;
+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 | int, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;
+export declare function spawnTearWithSeed(tearVariant: TearVariant, subType: int, position: Vector, seed: Seed, velocity?: Readonly<Vector>, spawner?: Entity | undefined): EntityTear;

package/dist/functions/enums.d.ts

@@ -55,19 +55,20 @@ export declare function getEnumLength<T>(transpiledEnum: T): int;
 export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
 export declare function getLastEnumValue<T>(transpiledEnum: T): T[keyof T];
 /**
- * Helper function to get a random element from the provided enum.
+ * Helper function to get a random value from the provided enum.
  *
- * @param transpiledEnum The enum to get an element from.
+ * @param transpiledEnum The enum to get the value from.
  * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
- * `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
-export declare function getRandomEnumElement<T>(transpiledEnum: T, seedOrRNG?: Seed | RNG, exceptions?: Array<T[keyof T]> | ReadonlyArray<T[keyof T]>): T[keyof T];
+export declare function getRandomEnumValue<T>(transpiledEnum: T, seedOrRNG?: Seed | RNG, exceptions?: Array<T[keyof T]> | ReadonlyArray<T[keyof T]>): T[keyof T];
 /**
  * Helper function to check every value of a custom enum for -1. This is helpful as a run-time check
  * because many methods of the Isaac class return -1 if they fail.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * enum EntityTypeCustom {
  *   FOO = Isaac.GetEntityTypeByName("Foo"),

package/dist/functions/enums.lua

@@ -63,7 +63,7 @@ function ____exports.getLastEnumValue(self, transpiledEnum)
     end
     return lastElement
 end
-function ____exports.getRandomEnumElement(self, transpiledEnum, seedOrRNG, exceptions)
+function ____exports.getRandomEnumValue(self, transpiledEnum, seedOrRNG, exceptions)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end

package/dist/functions/familiars.d.ts

@@ -22,11 +22,11 @@
  * @param player The player that owns the familiars.
  * @param collectibleType The collectible type of the collectible associated with this familiar.
  * @param targetCount The number of familiars that should exist. This function will add or remove
- * familiars until it matches the target count.
+ *                    familiars until it matches the target count.
  * @param familiarVariant The variant of the familiar to spawn or remove.
  * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
- * specified, it will search for existing familiars of all sub-types, and spawn new familiars with a
- * sub-type of 0.
+ *                        specified, it will search for existing familiars of all sub-types, and
+ *                        spawn new familiars with a sub-type of 0.
  */
 export declare function checkFamiliar(player: EntityPlayer, collectibleType: int, targetCount: int, familiarVariant: int, familiarSubType?: int): void;
 /**
@@ -53,8 +53,8 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: int
  * @param collectibleType The collectible type of the collectible associated with this familiar.
  * @param familiarVariant The variant of the familiar to spawn or remove.
  * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
- * specified, it will search for existing familiars of all sub-types, and spawn new familiars with a
- * sub-type of 0.
+ *                        specified, it will search for existing familiars of all sub-types, and
+ *                        spawn new familiars with a sub-type of 0.
  */
 export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: int, familiarVariant: int, familiarSubType?: int): void;
 export declare function isFamiliarThatShootsPlayerTears(familiar: EntityFamiliar): boolean;

package/dist/functions/familiars.lua

@@ -28,6 +28,6 @@ function ____exports.checkFamiliarFromCollectibles(self, player, collectibleType
     )
 end
 function ____exports.isFamiliarThatShootsPlayerTears(self, familiar)
-    return FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET:has(familiar.Type)
+    return FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET:has(familiar.Variant)
 end
 return ____exports

package/dist/functions/flag.d.ts

@@ -5,6 +5,7 @@ import { DamageFlag } from "isaac-typescript-definitions";
  * This is a variadic function, so pass as many flags as you want to add.
  *
  * Example 1:
+ *
  * ```ts
  * // Give the player spectral tears
  * const player = Isaac.GetPlayer();
@@ -12,6 +13,7 @@ import { DamageFlag } from "isaac-typescript-definitions";
  * ```
  *
  * Example 2:
+ *
  * ```ts
  * // Give the player spectral and homing tears
  * const player = Isaac.GetPlayer();
@@ -51,7 +53,8 @@ export declare function getFlagName<T extends BitFlag | BitFlag128>(flag: BitFla
  * This is a variadic function, so pass as many flags as you want to check for. If passed multiple
  * flags, it will only return true if all of the flags are set.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const player = Isaac.GetPlayer();
  * if (hasFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL) {
@@ -81,7 +84,8 @@ export declare function isSelfDamage(damageFlags: DamageFlag | BitFlags<DamageFl
  *
  * This is a variadic function, so pass as many flags as you want to remove.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Remove spectral tears from the player, if present
  * const player = Isaac.GetPlayer();

package/dist/functions/flying.d.ts

@@ -1,4 +1,4 @@
-import { CollectibleType } from "isaac-typescript-definitions";
+import { CollectibleType, TrinketType } from "isaac-typescript-definitions";
 /**
  * Returns a set of all of the collectibles that grant flight. This is derived from collectibles
  * that have `CacheFlag.FLYING` set in the "items.xml" file.
@@ -7,13 +7,13 @@ import { CollectibleType } from "isaac-typescript-definitions";
  * Vessel should be checked for via the `hasFlyingTemporaryEffect` function.
  *
  * @param pruneConditionalItems Whether or not collectibles that only grant flight conditionally
- * should be included in the set (like Empty Vessel).
+ *                              should be included in the set (like Empty Vessel).
  */
-export declare function getFlyingCollectibles(pruneConditionalItems: boolean): Set<CollectibleType | int>;
+export declare function getFlyingCollectibles(pruneConditionalItems: boolean): Set<CollectibleType>;
 /**
  * Returns a set of all of the trinkets that grant flight. (All trinkets that grant flight do so
  * conditionally, like Bat Wing.)
  */
-export declare function getFlyingTrinkets(): ReadonlySet<CollectibleType | int>;
+export declare function getFlyingTrinkets(): ReadonlySet<TrinketType>;
 export declare function hasFlyingTemporaryEffect(player: EntityPlayer): boolean;
 export declare function isFlyingCharacter(player: EntityPlayer): boolean;

package/dist/functions/gridEntity.d.ts

@@ -1,10 +1,10 @@
-import { GridEntityType } from "isaac-typescript-definitions";
+import { GridEntityType, GridEntityXMLType } from "isaac-typescript-definitions";
 /**
  * Helper function to convert the grid entity type found in a room XML file to the corresponding
  * grid entity type and variant normally used by the game. For example, a rock is represented as
  * 1000.0 in a room XML file, but `GridEntityType.ROCK` is equal to 2.
  */
-export declare function convertXMLGridEntityType(gridEntityXMLType: int, gridEntityXMLVariant: int): [int, int] | undefined;
+export declare function convertXMLGridEntityType(gridEntityXMLType: GridEntityXMLType, gridEntityXMLVariant: int): [GridEntityType, int] | undefined;
 /**
  * Gets the entities that have a hitbox that overlaps with any part of the square that the grid
  * entity is on.
@@ -19,14 +19,16 @@ export declare function getCollidingEntitiesWithGridEntity(gridEntity: GridEntit
  * Use this function with no arguments to get every grid entity, or specify a variadic amount of
  * arguments to match specific grid entity types.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * for (const gridEntity of getGridEntities()) {
  *   print(gridEntity.GetType())
  * }
  * ```
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const rocks = getGridEntities(
  *   GridEntityType.ROCK,
@@ -77,7 +79,8 @@ export declare function isPostBossVoidPortal(gridEntity: GridEntity): boolean;
  * Helper function to all grid entities in the room except for ones matching the grid entity types
  * provided.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * removeAllGridEntitiesExceptFor(
  *   GridEntityType.WALL,
@@ -92,7 +95,8 @@ export declare function removeAllGridExcept(...gridEntityTypes: GridEntityType[]
  * Helper function to remove all of the grid entities in the room that match the grid entity types
  * provided.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * removeAllMatchingGridEntities(
  *   GridEntityType.ROCK,
@@ -109,10 +113,11 @@ export declare function removeAllMatchingGridEntities(...gridEntityType: GridEnt
  *
  * @param gridEntity The grid entity to remove.
  * @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
- * Default is true. This is generally a good idea because if the room is not updated, you will be
- * unable to spawn another grid entity on the same tile until a frame has passed. However, doing
- * this is expensive, since it involves a call to `Isaac.GetRoomEntities`, so set it to false if you
- * need to invoke this function multiple times.
+ *                   Default is true. This is generally a good idea because if the room is not
+ *                   updated, you will be unable to spawn another grid entity on the same tile until
+ *                   a frame has passed. However, doing this is expensive, since it involves a call
+ *                   to `Isaac.GetRoomEntities`, so set it to false if you need to invoke this
+ *                   function multiple times.
  */
 export declare function removeGrid(gridEntity: GridEntity, updateRoom?: boolean): void;
 /**

package/dist/functions/gridEntity.lua

@@ -7,7 +7,6 @@ local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
 local getAllGridEntities
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
 local GridCollisionClass = ____isaac_2Dtypescript_2Ddefinitions.GridCollisionClass
 local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
 local PoopGridEntityVariant = ____isaac_2Dtypescript_2Ddefinitions.PoopGridEntityVariant
@@ -109,9 +108,6 @@ local BREAKABLE_GRID_ENTITY_TYPES_VARIANTS_BY_EXPLOSIONS = __TS__New(
     {(tostring(GridEntityType.STATUE) .. ".") .. tostring(StatueVariant.ANGEL)}
 )
 function ____exports.convertXMLGridEntityType(self, gridEntityXMLType, gridEntityXMLVariant)
-    if gridEntityXMLType == EntityType.TRIGGER_OUTPUT then
-        return nil
-    end
     local gridEntityArray = GRID_ENTITY_XML_MAP:get(gridEntityXMLType)
     if gridEntityArray == nil then
         error("Failed to find an entry in the grid entity map for XML entity type: " .. tostring(gridEntityXMLType))

package/dist/functions/kColor.d.ts

@@ -13,7 +13,7 @@ interface CopyKColorReturn {
  * Helper function to copy a `KColor` object.
  *
  * @param kColor The KColor object to copy. In the case of deserialization, this will actually be a
- * Lua table instead of an instantiated KColor class.
+ *               Lua table instead of an instantiated KColor class.
  * @param serializationType Default is `SerializationType.NONE`.
  */
 export declare function copyKColor<K extends KColor | SerializedKColor, S extends SerializationType>(kColor: K, serializationType: S): CopyKColorReturn[S];

package/dist/functions/level.d.ts

@@ -0,0 +1 @@
+export declare function fillLevelWithRedRooms(): void;

package/dist/functions/level.lua

@@ -0,0 +1,29 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____rooms = require("functions.rooms")
+local getNumRooms = ____rooms.getNumRooms
+local getRooms = ____rooms.getRooms
+local isDoorSlotValidAtGridIndexForRedRoom = ____rooms.isDoorSlotValidAtGridIndexForRedRoom
+function ____exports.fillLevelWithRedRooms(self)
+    local level = game:GetLevel()
+    local numRooms
+    repeat
+        do
+            local rooms = getRooms(nil)
+            numRooms = #rooms
+            for ____, roomDescriptor in ipairs(rooms) do
+                for ____, doorSlot in ipairs(getEnumValues(nil, DoorSlot)) do
+                    if isDoorSlotValidAtGridIndexForRedRoom(nil, doorSlot, roomDescriptor.GridIndex) then
+                        level:MakeRedRoomDoor(roomDescriptor.GridIndex, doorSlot)
+                    end
+                end
+            end
+        end
+    until not (numRooms ~= getNumRooms(nil))
+end
+return ____exports

package/dist/functions/log.d.ts

@@ -17,7 +17,7 @@ export declare function logColor(this: void, color: Color): void;
 export declare function logDamageFlags(this: void, flags: DamageFlag | BitFlags<DamageFlag>): void;
 export declare function logEffects(this: void, player: EntityPlayer): void;
 /** Helper function for printing out every entity (or filtered entity) in the current room. */
-export declare function logEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType | int): void;
+export declare function logEntities(this: void, includeBackgroundEffects: boolean, entityTypeFilter?: EntityType): void;
 /** Helper function for printing out every entity flag that is turned on. Useful when debugging. */
 export declare function logEntityFlags(this: void, flags: EntityFlag | BitFlags<EntityFlag>): void;
 export declare function logEntityID(this: void, entity: Entity): void;
@@ -37,7 +37,7 @@ export declare function logGameStateFlags(this: void): void;
 /**
  * Helper function for printing out every grid entity (or filtered grid entity) in the current room.
  */
-export declare function logGridEntities(this: void, includeWalls: boolean, gridEntityTypeFilter?: GridEntityType | int): void;
+export declare function logGridEntities(this: void, includeWalls: boolean, gridEntityTypeFilter?: GridEntityType): void;
 export declare function logKColor(this: void, kColor: KColor): void;
 /**
  * Helper function for printing out every level state flag that is turned on. Useful when debugging.

package/dist/functions/map.d.ts

@@ -5,7 +5,8 @@ export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
  * purposes of this function, both search text and map keys are converted to lowercase before
  * attempting to find a match.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const map = new <string, number>Map([
  *   ["foo", 123],

package/dist/functions/math.d.ts

@@ -1,4 +1,11 @@
 import { Direction } from "isaac-typescript-definitions";
+/**
+ * Helper function to normalize an integer.
+ *
+ * - If `x` is less than `min`, then it will be clamped to `min`.
+ * - If `x` is greater than `max`, then it will be clamped to `max`.
+ */
+export declare function clamp(x: int, min: int, max: int): int;
 export declare function getAngleDifference(angle1: float, angle2: float): float;
 /**
  * Helper function to get an array of equidistant points on the circumference around a circle.
@@ -10,7 +17,7 @@ export declare function getAngleDifference(angle1: float, angle2: float): float;
  * @param xMultiplier An optional multiplier to get the points around an oval. Default is 1.
  * @param yMultiplier An optional multiplier to get the points around an oval. Default is 1.
  * @param initialDirection By default, the first point on the circle will be on the top center, but
- * this can be optionally changed by specifying this argument.
+ *                         this can be optionally changed by specifying this argument.
  */
 export declare function getCircleDiscretizedPoints(centerPos: Vector, radius: float, numPoints: int, xMultiplier?: number, yMultiplier?: number, initialDirection?: Direction): Vector[];
 /**

package/dist/functions/math.lua

@@ -3,6 +3,12 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____direction = require("functions.direction")
 local directionToVector = ____direction.directionToVector
+function ____exports.clamp(self, x, min, max)
+    return math.max(
+        min,
+        math.min(x, max)
+    )
+end
 function ____exports.getAngleDifference(self, angle1, angle2)
     local subtractedAngle = angle1 - angle2
     return (subtractedAngle + 180) % 360 - 180

package/dist/functions/npc.d.ts

@@ -7,9 +7,9 @@ import { EntityType, ProjectilesMode } from "isaac-typescript-definitions";
  * @param position The staring position of the projectile.
  * @param velocity The starting velocity of the projectile.
  * @param projectilesMode The mode of the projectile. Optional. Default is
- * `ProjectilesMode.ONE_PROJECTILE`.
+ *                        `ProjectilesMode.ONE_PROJECTILE`.
  * @param projectileParams The parameters of the projectile. Optional. Default is
- * `ProjectileParams()`.
+ *                         `ProjectileParams()`.
  * @returns The fired projectile.
  */
 export declare function fireProjectiles(npc: EntityNPC, position: Vector, velocity: Vector, projectilesMode?: ProjectilesMode, projectileParams?: ProjectileParams): EntityProjectile[];
@@ -19,7 +19,7 @@ export declare function fireProjectiles(npc: EntityNPC, position: Vector, veloci
  * This function will not include NPCs on an internal blacklist, such as Death's scythes or Big Horn
  * holes.
  */
-export declare function getAliveNPCs(matchingEntityType?: EntityType | int, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
+export declare function getAliveNPCs(matchingEntityType?: EntityType, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
 /**
  * Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should
  * not actually keep the doors closed (like Death's scythes).