isaacscript-common 1.2.130 → 1.2.133

package/dist/cachedClasses.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * A cached version of the `Game()` constructor.
+ * A cached version of the class returned from the `Game()` constructor.
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *
@@ -9,7 +9,7 @@
  */
 export declare const game: Game;
 /**
- * A cached version of the `Isaac.GetItemConfig()()` constructor.
+ * A cached version of the class returned from the `Isaac.GetItemConfig()` constructor.
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *
@@ -18,7 +18,7 @@ export declare const game: Game;
  */
 export declare const itemConfig: ItemConfig;
 /**
- * A cached version of the `MusicManager()` constructor.
+ * A cached version of the class returned from the `MusicManager()` constructor.
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *
@@ -27,7 +27,7 @@ export declare const itemConfig: ItemConfig;
  */
 export declare const musicManager: MusicManager;
 /**
- * A cached version of the `SFXManager()` constructor.
+ * A cached version of the class returned from the `SFXManager()` constructor.
  *
  * Use this instead of invoking the constructor again for a miniscule performance increase.
  *

package/dist/constants.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * The distance of the laser when Azazel does not have any range up items yet.
- * For more info, see the documentation for the `getAzazelBrimstoneDistance()` function.
+ * For more info, see the documentation for the `getAzazelBrimstoneDistance` function.
  */
 export declare const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
 /**
@@ -51,7 +51,7 @@ export declare const DOOR_HITBOX_DISTANCE = 11;
 export declare const EGGY_STATE_FRAME_OF_FINAL_SPIDER = 45;
 /**
  * A non-existent or completely transparent PNG file for use in clearing sprites. For more
- * information, see the documentation for the `clearSprite()` helper function.
+ * information, see the documentation for the `clearSprite` helper function.
  */
 export declare const EMPTY_PNG_PATH = "gfx/none.png";
 export declare const FAMILIARS_THAT_SHOOT_PLAYER_TEARS: ReadonlySet<FamiliarVariant>;

package/dist/features/deployJSONRoom.d.ts

@@ -18,7 +18,7 @@ import { JSONRoom } from "../types/JSONRoom";
  * Default is `Random()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  * what the function is doing. Default is false.
- * @returns Before using the seed for spawning each entity, it is iterated with `nextSeed()`. The
+ * @returns Before using the seed for spawning each entity, it is iterated with `nextSeed`. The
  * function returns the final iterated seed after spawning everything, which can be used in
  * subsequent room deployments.
  */
@@ -46,7 +46,7 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom, seed?: Seed, verbose?
  * that, it is also used for spawning every entity in the room. Default is `Random()`.
  * @param verbose Optional. If specified, will write entries to the "log.txt" file that describe
  * what the function is doing. Default is false.
- * @returns Before using the seed for spawning each entity, it is iterated with `nextSeed()`. The
+ * @returns Before using the seed for spawning each entity, it is iterated with `nextSeed`. The
  * function returns the final iterated seed after spawning everything, which can be used in
  * subsequent room deployments.
  */

package/dist/functions/debug.d.ts

@@ -7,7 +7,7 @@
 export declare function getTraceback(): string;
 /**
  * Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
- * `console.trace()` function.
+ * `console.trace` function.
  *
  * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
  * enabled.

package/dist/functions/doors.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="isaac-typescript-definitions" />
 export declare function closeAllDoors(): void;
 /**
- * Use this instead of the `door.Close()` method if you want the door to immediately close without
- * an animation.
+ * Use this instead of the `GridEntityDoor.Close` method if you want the door to immediately close
+ * without an animation.
  */
 export declare function closeDoorFast(door: GridEntityDoor): void;
 /**
@@ -63,9 +63,9 @@ export declare function isRepentanceDoor(door: GridEntityDoor): boolean;
 export declare function isSecretRoomDoor(door: GridEntityDoor): boolean;
 /**
  * Helper function to reset an unlocked door back to a locked state. Doing this is non-trivial
- * because in addition to calling the `SetLocked()` method, you must also:
+ * because in addition to calling the `GridEntityDoor.SetLocked` method, you must also:
  *
- * - Modify the `VisitedCount` of the room's `RoomDescription` to be set to 0.
+ * - Set the `VisitedCount` of the room's `RoomDescription` to 0.
  * - Set the variant to `DoorVariant.DOOR_LOCKED`.
  * - Close the door.
  */
@@ -76,8 +76,8 @@ export declare function lockDoor(door: GridEntityDoor): void;
  */
 export declare function openAllDoors(): void;
 /**
- * Use this instead of the `door.Open()` method if you want the door to immediately open without
- * an animation.
+ * Use this instead of the `GridEntityDoor.Open` method if you want the door to immediately open
+ * without an animation.
  */
 export declare function openDoorFast(door: GridEntityDoor): void;
 /**

package/dist/functions/entity.d.ts

@@ -11,7 +11,7 @@ export declare function anyEntityCloserThan(entities: Entity[], position: Vector
  * @param subType Default is -1.
  * @param ignoreFriendly Default is false.
  */
-export declare function countEntities(entityType?: EntityType | int, variant?: number, subType?: number, ignoreFriendly?: boolean): number;
+export declare function countEntities(entityType?: EntityType | int, variant?: number, subType?: number, ignoreFriendly?: boolean): int;
 /**
  * Given an array of entities, this helper function returns the closest one to a provided reference
  * entity.
@@ -33,9 +33,9 @@ export declare function getFilteredNewEntities<T extends AnyEntity>(oldEntities:
  * 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.)
+ * 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.)
  *
  * Example:
  * ```

package/dist/functions/gridEntity.d.ts

@@ -102,15 +102,15 @@ export declare function removeAllMatchingGridEntities(...gridEntityType: GridEnt
  * @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.
+ * 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 removeGridEntity(gridEntity: GridEntity, updateRoom?: boolean): void;
 /**
  * Helper function to make a grid entity invisible. This is accomplished by setting its sprite to
  * an empty/missing PNG file.
  *
- * For more information, see the documentation for the `clearSprite()` helper function.
+ * For more information, see the documentation for the `clearSprite` helper function.
  */
 export declare function setGridEntityInvisible(gridEntity: GridEntity): void;
 /**
@@ -119,16 +119,21 @@ export declare function setGridEntityInvisible(gridEntity: GridEntity): void;
  */
 export declare function spawnGiantPoop(topLeftGridIndex: int): void;
 /**
- * Helper function to spawn a grid entity. This function assumes you want to give the grid entity a
- * variant of 0. Use this instead of the `Isaac.GridSpawn()` method since it:
+ * Helper function to spawn a grid entity.
+ *
+ * This function assumes you want to give the grid entity a variant of 0. If you want to specify a
+ * variant, use the `spawnGridEntityWithVariant` helper function instead.
+ *
+ * Use this instead of the `Isaac.GridSpawn` method since it:
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify the grid index instead of the position
  */
 export declare function spawnGridEntity(gridEntityType: GridEntityType, gridIndex: int): GridEntity | undefined;
 /**
- * Helper function to spawn a grid entity with a specific variant. Use this instead of the
- * `Isaac.GridSpawn()` method since it:
+ * Helper function to spawn a grid entity with a specific variant.
+ *
+ * Use this instead of the `Isaac.GridSpawn` method since it:
  * - handles giving pits collision
  * - removes existing grid entities on the same tile, if any
  * - allows you to specify the grid index instead of the position

package/dist/functions/log.d.ts

@@ -32,7 +32,7 @@ export declare function logAllSeedEffects(this: void): void;
 /** Helper function for printing out every tear flag that is turned on. Useful when debugging. */
 export declare function logAllTearFlags(this: void, flags: int): void;
 /** Helper function for printing out every use flag that is turned on. Useful when debugging. */
-export declare function logAllUseFlags(this: void, flags: int): void;
+export declare function logAllUseFlags(this: void, _flags: int): void;
 export declare function logArray<T>(this: void, array: T[]): void;
 export declare function logColor(this: void, color: Color): void;
 export declare function logEntity(this: void, entity: Entity): void;

package/dist/functions/log.lua

@@ -107,8 +107,8 @@ end
 function ____exports.logAllTearFlags(flags)
     ____exports.logAllFlags(flags, TearFlags, "tear")
 end
-function ____exports.logAllUseFlags(flags)
-    ____exports.logAllFlags(flags, UseFlag, "use")
+function ____exports.logAllUseFlags(_flags)
+    ____exports.log("The \"logAllUseFlags\" helper function is temporarily disabled while the UseFlag enum remains unpatched in vanilla.")
 end
 function ____exports.logArray(array)
     local arrayString = arrayToString(nil, array)

package/dist/functions/npc.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to make an NPC fire a projectile. Returns the fired projectile. Use this function
- * instead of `EntityNPC.FireProjectiles()`, since that returns void.
+ * instead of the `EntityNPC.FireProjectiles` method, since that returns void.
  *
  * @param npc The NPC to fire the projectile from.
  * @param position The staring position of the projectile.
@@ -29,7 +29,7 @@ export declare function getAliveBosses(matchingEntityType?: EntityType | int, ma
 export declare function getAliveNPCs(matchingEntityType?: EntityType | int, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
 /** Helper function to get all of the bosses in the room. */
 export declare function getBosses(matchingEntityType?: EntityType | int, matchingVariant?: int, matchingSubType?: int, ignoreFriendly?: boolean): EntityNPC[];
-/** The same thing as the `getEntities()` function, but returns only NPCs. */
+/** 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[];
 /**
  * Checks for specific NPCs that have "CanShutDoors" set to true naturally by the game, but should

package/dist/functions/player.d.ts

@@ -38,7 +38,7 @@ export declare function characterGetsBlackHeartFromEternalHeart(character: Playe
  * `Isaac.GetPlayer`.
  *
  * This function is almost never what you want to use. For most intents and purposes, use the
- * `getPlayers()` helper function instead to get a more filtered list of players.
+ * `getPlayers` helper function instead to get a filtered list of players.
  */
 export declare function getAllPlayers(): EntityPlayer[];
 /**
@@ -47,7 +47,7 @@ export declare function getAllPlayers(): EntityPlayer[];
  *
  * The formula for calculating it is: 32 - 2.5 * player.TearHeight
  */
-export declare function getAzazelBrimstoneDistance(playerOrTearHeight: EntityPlayer | float): number;
+export declare function getAzazelBrimstoneDistance(playerOrTearHeight: EntityPlayer | float): float;
 /**
  * Returns the number of black hearts that the player has, excluding any soul hearts. For example,
  * if the player has one full black heart, one full soul heart, and one half black heart, this
@@ -58,12 +58,12 @@ export declare function getAzazelBrimstoneDistance(playerOrTearHeight: EntityPla
 export declare function getBlackHearts(player: EntityPlayer): int;
 /**
  * Returns the maximum heart containers that the provided character can have. Normally, this is 12,
- * but with Keeper it is 3, with Tainted Keeper it is 2. Does not account for Birthright or Mother's
- * Kiss; use the `getPlayerMaxHeartContainers()` function for that.
+ * but with Keeper it is 3, and with Tainted Keeper it is 2. This does not account for Birthright or
+ * Mother's Kiss; use the `getPlayerMaxHeartContainers` helper function for that.
  */
 export declare function getCharacterMaxHeartContainers(character: PlayerType | int): int;
 /** Helper function to get an array containing the characters of all of the current players. */
-export declare function getCharacters(): number[];
+export declare function getCharacters(): PlayerType[];
 export declare function getClosestPlayer(position: Vector): EntityPlayer;
 /**
  * Most characters have a 56 frame death animation (i.e. the "Death" animation).
@@ -77,7 +77,7 @@ export declare function getDeathAnimationName(player: EntityPlayer): string;
  */
 export declare function getEffectsList(player: EntityPlayer): TemporaryEffect[];
 /**
- * Helper function to return the player with the highest ID, according to the `Isaac.GetPlayer()`
+ * Helper function to return the player with the highest ID, according to the `Isaac.GetPlayer`
  * method.
  */
 export declare function getFinalPlayer(): EntityPlayer;
@@ -137,8 +137,8 @@ export declare function getPlayerFromIndex(playerIndex: PlayerIndex): EntityPlay
  * - We cannot use `EntityPlayer.InitSeed` because it is not consistent with additional players
  *   beyond the first.
  *
- * Instead, we use `EntityPlayer.GetCollectibleRNG()` with an arbitrary value of Sad Onion (1). This
- * works even if the player does not have any Sad Onions.
+ * Instead, we use the `EntityPlayer.GetCollectibleRNG` method with an arbitrary value of Sad Onion
+ * (1). This works even if the player does not have any Sad Onions.
  *
  * Since the RNG value is the same for both Tainted Lazarus and Dead Tainted Lazarus, we revert to
  * using the RNG of The Inner Eye (2) for Dead Tainted Lazarus.
@@ -151,13 +151,14 @@ export declare function getPlayerFromIndex(playerIndex: PlayerIndex): EntityPlay
 export declare function getPlayerIndex(player: EntityPlayer, differentiateForgottenAndSoul?: boolean): PlayerIndex;
 /**
  * Helper function to return the index of this player with respect to the output of the
- * `Isaac.GetPlayer()` function.
+ * `Isaac.GetPlayer` method.
  */
 export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int | undefined;
 /**
  * Returns the maximum heart containers that the provided player can have. Normally, this is 12, but
  * it can change depending on the character (e.g. Keeper) and other things (e.g. Mother's Kiss).
- * Does not account for Broken Hearts; use the `getPlayerAvailableHeartSlots()` function for that.
+ * This function does not account for Broken Hearts; use the `getPlayerAvailableHeartSlots` helper
+ * function for that.
  */
 export declare function getPlayerMaxHeartContainers(player: EntityPlayer): int;
 /**
@@ -193,6 +194,13 @@ export declare function getPlayers(performCharacterExclusions?: boolean): Entity
  * for. Returns true if any of the characters supplied are present.
  */
 export declare function getPlayersOfType(...characters: Array<PlayerType | int>): EntityPlayer[];
+/**
+ * Helper function to get only the players that have a certain collectible.
+ *
+ * This function is variadic, meaning that you can supply as many collectible types as you want to
+ * check for. It only returns the players that have all of the collectibles.
+ */
+export declare function getPlayersWithCollectible(...collectibleTypes: Array<CollectibleType | int>): EntityPlayer[];
 /**
  * Returns the number of soul hearts that the player has, excluding any black hearts. For example,
  * if the player has one full black heart, one full soul heart, and one half black heart, this
@@ -218,7 +226,7 @@ export declare function getSubPlayerParent(subPlayer: EntitySubPlayer): EntityPl
  * This function does not validate whether or not the provided player is Tainted Magdalene; that
  * should be accomplished before invoking this function.
  */
-export declare function getTaintedMagdaleneNonTemporaryMaxHearts(player: EntityPlayer): number;
+export declare function getTaintedMagdaleneNonTemporaryMaxHearts(player: EntityPlayer): int;
 /**
  * Helper function to return the active charge and the battery charge combined. This is useful
  * because you are not able to set the battery charge directly.
@@ -287,8 +295,8 @@ export declare function removeCollectibleCostume(player: EntityPlayer, collectib
 /**
  * Helper function to remove the Dead Eye multiplier from a player.
  *
- * Note that each time the `EntityPlayer.ClearDeadEyeCharge()` function is called, it only has a
- * chance of working, so this function calls it 100 times to be safe.
+ * Note that each time the `EntityPlayer.ClearDeadEyeCharge` method is called, it only has a chance
+ * of working, so this function calls it 100 times to be safe.
  */
 export declare function removeDeadEyeMultiplier(player: EntityPlayer): void;
 /**
@@ -298,8 +306,9 @@ export declare function removeDeadEyeMultiplier(player: EntityPlayer): void;
 export declare function removeTrinketCostume(player: EntityPlayer, trinketType: TrinketType | int): void;
 /**
  * Helper function to set an active collectible to a particular slot. This has different behavior
- * than calling `player.AddCollectible()` with the `activeSlot` argument, because this function will
- * not shift existing items into the Schoolbag and it handles `ActiveSlot.SLOT_POCKET2`.
+ * than calling the `player.AddCollectible` method with the `activeSlot` argument, because this
+ * function will not shift existing items into the Schoolbag and it handles
+ * `ActiveSlot.SLOT_POCKET2`.
  *
  * Note that if an item is set to `ActiveSlot.SLOT_POCKET2`, it will disappear after being used and
  * will be automatically removed upon entering a new room.

package/dist/functions/player.lua

@@ -9,6 +9,7 @@ local __TS__ArrayFind = ____lualib.__TS__ArrayFind
 local Map = ____lualib.Map
 local __TS__Iterator = ____lualib.__TS__Iterator
 local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
 local ____exports = {}
 local getPlayerIndexCollectibleType, getAdjustedPlayerName, isTaintedModded, DEFAULT_COLLECTIBLE_TYPE, EXCLUDED_CHARACTERS
 local ____cachedClasses = require("cachedClasses")
@@ -498,6 +499,17 @@ function ____exports.getPlayersOfType(self, ...)
         end
     )
 end
+function ____exports.getPlayersWithCollectible(self, ...)
+    local collectibleTypes = {...}
+    local players = ____exports.getPlayers(nil)
+    return __TS__ArrayFilter(
+        players,
+        function(____, player) return __TS__ArrayEvery(
+            collectibleTypes,
+            function(____, collectibleType) return player:HasCollectible(collectibleType) end
+        ) end
+    )
+end
 function ____exports.getSoulHearts(self, player)
     local soulHearts = player:GetSoulHearts()
     local blackHearts = ____exports.getBlackHearts(nil, player)
@@ -604,9 +616,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch129 = activeSlot
-        local ____cond129 = ____switch129 == ActiveSlot.SLOT_PRIMARY
-        if ____cond129 then
+        local ____switch132 = activeSlot
+        local ____cond132 = ____switch132 == ActiveSlot.SLOT_PRIMARY
+        if ____cond132 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -615,8 +627,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond129 = ____cond129 or ____switch129 == ActiveSlot.SLOT_SECONDARY
-        if ____cond129 then
+        ____cond132 = ____cond132 or ____switch132 == ActiveSlot.SLOT_SECONDARY
+        if ____cond132 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -631,16 +643,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond129 = ____cond129 or ____switch129 == ActiveSlot.SLOT_POCKET
-        if ____cond129 then
+        ____cond132 = ____cond132 or ____switch132 == ActiveSlot.SLOT_POCKET
+        if ____cond132 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond129 = ____cond129 or ____switch129 == ActiveSlot.SLOT_POCKET2
-        if ____cond129 then
+        ____cond132 = ____cond132 or ____switch132 == ActiveSlot.SLOT_POCKET2
+        if ____cond132 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/playerHealth.d.ts

@@ -5,7 +5,7 @@ import { PlayerHealth } from "../types/PlayerHealth";
  * `setPlayerHealth` function to restore the player's health back to a certain configuration at a
  * later time.
  *
- * This is based on the `REVEL.StoreHealth()` function in the Revelations mod.
+ * This is based on the `REVEL.StoreHealth` function in the Revelations mod.
  */
 export declare function getPlayerHealth(player: EntityPlayer): PlayerHealth;
 /**
@@ -13,7 +13,7 @@ export declare function getPlayerHealth(player: EntityPlayer): PlayerHealth;
  * with the `getPlayerHealth` function to restore the player's health back to a certain
  * configuration at a later time.
  *
- * Based on the `REVEL.LoadHealth()` function in the Revelations mod.
+ * Based on the `REVEL.LoadHealth` function in the Revelations mod.
  */
 export declare function setPlayerHealth(player: EntityPlayer, playerHealth: PlayerHealth): void;
 export declare function removeAllPlayerHealth(player: EntityPlayer): void;

package/dist/functions/pocketItems.d.ts

@@ -2,7 +2,7 @@
 import { PocketItemDescription } from "../types/PocketItemDescription";
 export declare function getFirstCardOrPill(player: EntityPlayer): PocketItemDescription | undefined;
 /**
- * Use this helper function as a workaround for `EntityPlayer.GetPocketItem()` not working
+ * Use this helper function as a workaround for the `EntityPlayer.GetPocketItem` method not working
  * correctly.
  *
  * Note that due to API limitations, there is no way to determine the location of a Dice Bag trinket

package/dist/functions/positionVelocity.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to get a room position that is not overlapping with a grid entity, a heaven door,
- * or a player. The `Room.FindFreePickupSpawnPosition()` function will return locations that overlap
+ * or a player. The `Room.FindFreePickupSpawnPosition` method will return locations that overlap
  * with heaven doors and partially overlap with players, if the thing being spawned is bigger than a
  * tile (like a Blood Donation Machine). Use this function instead if you want to account for those
  * specific situations.
@@ -14,20 +14,19 @@ export declare function findFreePosition(startingPosition: Vector, avoidActiveEn
 /**
  * Helper function to get a map containing the positions of every entity in the current room.
  *
- * This is useful for rewinding entity positions at a later time. Also see `setEntityPositions()`.
+ * This is useful for rewinding entity positions at a later time. Also see `setEntityPositions`.
  *
- * @param entities Optional. If provided, will only get the positions of the provided entities. This
- * can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple times.
+ * @param entities Optional. If provided, will only get the positions of the provided entities. Use
+ * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
  */
 export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Vector>;
 /**
  * Helper function to get a map containing the velocities of every entity in the current room.
  *
- * This is useful for rewinding entity velocities at a later time. Also see `setEntityVelocities()`.
+ * This is useful for rewinding entity velocities at a later time. Also see `setEntityVelocities`.
  *
- * @param entities Optional. If provided, will only get the velocities of the provided entities.
- * This can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple
- * times.
+ * @param entities Optional. If provided, will only get the velocities of the provided entities. Use
+ * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
  */
 export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
 /**
@@ -36,11 +35,11 @@ export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, V
  * be skipped.
  *
  * This function is useful for rewinding entity positions at a later time. Also see
- * `getEntityPositions()`.
+ * `getEntityPositions`.
  *
  * @param entityPositions The map providing the positions for every entity.
- * @param entities Optional. If provided, will only set the positions of the provided entities. This
- * can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple times.
+ * @param entities Optional. If provided, will only set the positions of the provided entities. Use
+ * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
  */
 export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>, entities?: Entity[]): void;
 /**
@@ -49,11 +48,10 @@ export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>
  * be skipped.
  *
  * This function is useful for rewinding entity velocities at a later time. Also see
- * `getEntityVelocities()`.
+ * `getEntityVelocities`.
  *
  * @param entityVelocities The map providing the velocities for every entity.
- * @param entities Optional. If provided, will only set the velocities of the provided entities.
- * This can be used to cache the entities to avoid invoking `Isaac.GetRoomEntities()` multiple
- * times.
+ * @param entities Optional. If provided, will only set the velocities of the provided entities. Use
+ * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
  */
 export declare function setEntityVelocities(entityVelocities: Map<PtrHash, Vector>, entities?: Entity[]): void;

package/dist/functions/random.d.ts

@@ -1,14 +1,14 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * This returns a random float between 0 and 1. It is inclusive on the low end, but exclusive on
- * the high end. (This is because `RNG.RandomFloat()` can return a value of 0.999, but it will never
- * return a value of exactly 1.)
+ * the high end. (This is because the `RNG.RandomFloat` method can return a value of 0.999, but it
+ * will never return a value of exactly 1.)
  */
 export declare function getRandom(seed?: Seed): float;
 /**
  * This returns a random float between min and max. It is inclusive on the low end, but exclusive on
- * the high end. (This is because `RNG.RandomFloat()` can return a value of 0.999, but it will never
- * return a value of exactly 1.)
+ * the high end. (This is because the `RNG.RandomFloat` method can return a value of 0.999, but it
+ * will never return a value of exactly 1.)
  *
  * Example:
  * ```

package/dist/functions/revive.d.ts

@@ -5,8 +5,8 @@
  */
 export declare function isDamageToPlayerFatal(player: EntityPlayer, damageAmount: int, damageSource: EntityRef, lastDamageGameFrame: int | undefined): boolean;
 /**
- * The `EntityPlayer.WillPlayerRevive()` function does not properly account for Mysterious Paper, so
- * use this helper function instead for more robust revival detection.
+ * The `EntityPlayer.WillPlayerRevive` method does not properly account for Mysterious Paper, so use
+ * this helper function instead for more robust revival detection.
  */
 export declare function willPlayerRevive(player: EntityPlayer): boolean;
 /**

package/dist/functions/rooms.d.ts

@@ -16,7 +16,7 @@ export declare function getAllRoomGridIndexes(): int[];
  */
 export declare function getCurrentDimension(): Dimension;
 /**
- * Alias for the `Level.GetCurrentRoomDesc()` method. Use this to make it more clear what type of
+ * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
  * `RoomDescriptor` object that you are retrieving.
  */
 export declare function getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOnly;
@@ -73,8 +73,8 @@ export declare function getRoomGridIndexesForType(...roomTypes: RoomType[]): int
 export declare function getRoomItemPoolType(): ItemPoolType;
 /**
  * Helper function to get the list grid index of the provided room, which is equal to the index in
- * the `Level.GetRooms().Get()` method. In other words, this is equal to the order that the room was
- * created by the floor generation algorithm.
+ * the `RoomList.Get` method. In other words, this is equal to the order that the room was created
+ * by the floor generation algorithm.
  *
  * Use this as an index for data structures that store data per room, since it is unique across
  * different dimensions.
@@ -126,8 +126,8 @@ export declare function getRoomVariant(roomGridIndex?: int): int;
  */
 export declare function getRoomVisitedCount(roomGridIndex?: int): int;
 /**
- * Helper function to get the room descriptor for every room on the level. Uses the
- * `Level.GetRooms()` method to accomplish this.
+ * Helper function to get the room descriptor for every room on the level. Uses the `Level.GetRooms`
+ * method to accomplish this.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
  * extra-dimensional rooms are automatically be generated and can be seen when you iterate over the
@@ -188,7 +188,7 @@ export declare function inMinibossRoomOf(minibossID: MinibossID): boolean;
 export declare function inSecretShop(): boolean;
 /**
  * Helper function to determine whether or not the current room is the starting room of a floor.
- * Only returns true for the starting room of the primary dimension (meaning that being in the
+ * It only returns true for the starting room of the primary dimension (meaning that being in the
  * starting room of the mirror world does not count).
  */
 export declare function inStartingRoom(): boolean;
@@ -217,10 +217,10 @@ export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
  */
 export declare function isRoomInsideMap(roomGridIndex?: int): boolean;
 /**
- * If `Room.Update()` is called in a PostNewRoom callback, then some entities will slide around
- * (such as the player). Since those entity velocities are already at zero, setting them to zero
- * will have no effect. Thus, a generic solution is to record all of the entity positions/velocities
- * before updating the room, and then restore those positions/velocities.
+ * If the `Room.Update` method is called in a PostNewRoom callback, then some entities will slide
+ * around (such as the player). Since those entity velocities are already at zero, setting them to
+ * zero will have no effect. Thus, a generic solution is to record all of the entity
+ * positions/velocities before updating the room, and then restore those positions/velocities.
  */
 export declare function roomUpdateSafe(): void;
 /**
@@ -237,9 +237,9 @@ export declare function setRoomUncleared(): void;
 /**
  * Helper function to change the current room. It can be used for both teleportation and "normal"
  * room transitions, depending on what is passed for the `direction` and `roomTransitionAnim`
- * arguments. Use this function instead of invoking `Game.StartRoomTransition()` directly so that
- * you do not forget to set `Level.LeaveDoor` property and to prevent crashing on invalid room grid
- * indexes.
+ * arguments. Use this function instead of invoking the `Game.StartRoomTransition` method directly
+ * so that you do not forget to set `Level.LeaveDoor` property and to prevent crashing on invalid
+ * room grid indexes.
  *
  * @param roomGridIndex The room grid index of the destination room.
  * @param direction Optional. Default is `Direction.NO_DIRECTION`.

package/dist/functions/spawnCollectible.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to spawn a collectible. Use this instead of `Game.Spawn()` because it handles the
- * cases of Tainted Keeper collectibles costing coins and preventing quest items from being rotated
- * by Tainted Isaac's rotation mechanic.
+ * Helper function to spawn a collectible. Use this instead of the `Game.Spawn` method because it
+ * handles the cases of Tainted Keeper collectibles costing coins and preventing quest items from
+ * being rotated by Tainted Isaac's rotation mechanic. (Rotation prevention will only occur in
+ * upgraded mods.)
  *
  * @param collectibleType The collectible type to spawn.
  * @param position The position to spawn the collectible at.

package/dist/functions/sprite.d.ts

@@ -18,9 +18,9 @@ export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
  * specific animation to check.
  *
  * Note that this function is bugged with the Stop Watch or the Broken Watch, since using the
- * `SetFrame()` method will reset the internal accumulator used to slow down the playback speed of
- * the animation. (The `PlaybackSpeed` property of the sprite is not used.) Thus, it is only safe to
- * use this function on animations that are not slowed down by Stop Watch or Broken Watch, such as
- * player animations.
+ * `Sprite.SetFrame` method will reset the internal accumulator used to slow down the playback speed
+ * of the animation. (The `PlaybackSpeed` property of the sprite is not used.) Thus, it is only safe
+ * to use this function on animations that are not slowed down by Stop Watch or Broken Watch, such
+ * as player animations.
  */
 export declare function getFinalFrameOfAnimation(sprite: Sprite, animation?: string): int;

package/dist/functions/ui.d.ts

@@ -2,7 +2,7 @@
 /**
  * Helper function to get the width of the first player's hearts on the UI. This is useful for
  * drawing UI elements to the right of where the player's hearts are. Make sure to use this in
- * combination with the `getHUDOffsetVector()` helper function.
+ * combination with the the `getHUDOffsetVector` helper function.
  */
 export declare function getHeartsUIWidth(): int;
 /**

package/dist/functions/utils.d.ts

@@ -50,7 +50,7 @@ export declare const ensureAllCases: (obj: never) => never;
  * https://isaacscript.github.io/docs/gotchas#iterating-over-enums
  *
  * You can also use this function for vanilla enums, which can make code easier to read than using
- * `pairs` or `Object.values()`.
+ * `pairs` or `Object.values`.
  */
 export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
 /**
@@ -78,9 +78,9 @@ export declare function isLuaDebugEnabled(): boolean;
  */
 export declare function onSetSeed(): boolean;
 /**
- * Helper function to print something to the in-game console. Use this instead of invoking
- * `Isaac.ConsoleOutput()` directly because it will automatically insert a newline at the end of the
- * message (which `Isaac.ConsoleOutput()` does not do by default).
+ * Helper function to print something to the in-game console. Use this instead of invoking the
+ * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
+ * of the message (which `Isaac.ConsoleOutput` does not do by default).
  */
 export declare function printConsole(msg: string): void;
 /**

package/dist/upgradeMod.d.ts

@@ -18,7 +18,7 @@ import { ModUpgraded } from "./types/ModUpgraded";
  * For a list of all custom callbacks, check out the
  * [Function Signatures](https://isaacscript.github.io/docs/function-signatures#custom-callbacks).
  *
- * @param modVanilla The mod object returned by the `RegisterMod()` function.
+ * @param modVanilla The mod object returned by the `RegisterMod` function.
  * @param verbose Enables verbose logging for the purposes of crash troubleshooting.
  * Defaults to false.
  * @returns The upgraded mod object.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.130",
+  "version": "1.2.133",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,8 +26,8 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.2",
-    "isaac-typescript-definitions": "^1.0.361",
-    "isaacscript-lint": "^1.0.84",
+    "isaac-typescript-definitions": "^1.0.364",
+    "isaacscript-lint": "^1.0.88",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",
     "typescript": "4.5.5"