isaacscript-common 2.0.11 → 2.0.12

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/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

@@ -7,7 +7,7 @@ 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>;
 /**

package/dist/functions/gridEntity.d.ts

@@ -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/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/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

@@ -10,7 +10,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/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[];

package/dist/functions/pickups.d.ts

@@ -54,7 +54,7 @@ export declare function removeAllCoins(coinSubType?: CoinSubType | int, cap?: in
  * Helper function to remove all of the collectibles in the room.
  *
  * @param collectibleType Optional. If specified, will only remove collectibles that match this
- * collectible type.
+ *                        collectible type.
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns True if one or more collectibles were removed, false otherwise.
  */
@@ -95,7 +95,7 @@ export declare function removeAllSacks(sackSubType?: SackSubType | int, cap?: in
  * Helper function to remove all of the trinkets in the room.
  *
  * @param trinketType Optional. If specified, will only remove trinkets that match this trinket
- * type.
+ *                    type.
  * @param cap Optional. If specified, will only remove the given amount of trinkets.
  * @returns True if one or more trinkets were removed, false otherwise.
  */

package/dist/functions/pills.d.ts

@@ -27,7 +27,8 @@ export declare function getPillEffectClass(pillEffect: PillEffect | int): ItemCo
 /**
  * Helper function to get a pill effect name from a PillEffect enum value.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const pillEffect = PillEffect.BAD_GAS;
  * const pillEffectName = getPillEffectName(pillEffect); // trinketName is "Bad Gas"

package/dist/functions/player.d.ts

@@ -28,7 +28,7 @@ export declare function anyPlayerHasTrinket(trinketType: TrinketType | int): boo
  */
 export declare function anyPlayerIs(...matchingCharacters: Array<PlayerType | int>): boolean;
 /**
- * Helper function to determine if a player will destroy a rock/pot/skull/etc. if they walk over it.
+ * Helper function to determine if a player will destroy a rock/pot/skull if they walk over it.
  *
  * The following situations allow for this to be true:
  * - the player has Leo (collectible 302)
@@ -268,7 +268,7 @@ export declare function removeTrinketCostume(player: EntityPlayer, trinketType:
  * @param collectibleType The collectible type of the item to give.
  * @param activeSlot The slot to set.
  * @param charge Optional. The argument of charges to set. If not specified, the item will be set
- * with maximum charges.
+ *               with maximum charges.
  * @param keepInPools Optional. Whether or not to remove the item from pools. Default is false.
  */
 export declare function setActiveItem(player: EntityPlayer, collectibleType: CollectibleType, activeSlot: ActiveSlot, charge?: int, keepInPools?: boolean): void;

package/dist/functions/playerIndex.d.ts

@@ -51,7 +51,8 @@ export declare function getPlayerIndexVanilla(playerToFind: EntityPlayer): int |
  * If this is not desired, use the `getAllPlayers` helper function instead.
  *
  * @param performCharacterExclusions Whether or not to exclude characters that are not directly
- * controlled by the player (i.e. Esau & Tainted Soul). Default is false.
+ *                                   controlled by the player (i.e. Esau & Tainted Soul). Default is
+ *                                   false.
  */
 export declare function getPlayers(performCharacterExclusions?: boolean): EntityPlayer[];
 /**

package/dist/functions/positionVelocity.d.ts

@@ -10,7 +10,7 @@ export declare function anyPlayerCloserThan(position: Vector, distance: float):
  * specific situations.
  *
  * @param startingPosition The position to start searching from. If this position is not overlapping
- * with anything, then it will be returned.
+ *                         with anything, then it will be returned.
  * @param avoidActiveEntities Optional. Default is false.
  */
 export declare function findFreePosition(startingPosition: Vector, avoidActiveEntities?: boolean): Vector;
@@ -20,7 +20,8 @@ export declare function findFreePosition(startingPosition: Vector, avoidActiveEn
  * 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. Use
- * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
  */
 export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Vector>;
 /**
@@ -29,7 +30,8 @@ export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Ve
  * 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. Use
- * this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method multiple times.
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
  */
 export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
 /**
@@ -42,7 +44,8 @@ export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, V
  *
  * @param entityPositions The map providing the positions for every entity.
  * @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.
+ *                 this with cached entities to avoid invoking the `Isaac.GetRoomEntities` method
+ *                 multiple times.
  */
 export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>, entities?: Entity[]): void;
 /**
@@ -55,6 +58,7 @@ export declare function setEntityPositions(entityPositions: Map<PtrHash, Vector>
  *
  * @param entityVelocities The map providing the velocities for every entity.
  * @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.
+ *                 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

@@ -4,13 +4,14 @@
  * high end. (This is because the `RNG.RandomFloat` method will never return a value of exactly 1.)
  *
  * @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()`.
  */
 export declare function getRandom(seedOrRNG?: Seed | RNG): float;
 /**
  * This returns a random float between min and max.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const realNumberBetweenOneAndThree = getRandomFloat(1, 3);
  * ```
@@ -18,7 +19,7 @@ export declare function getRandom(seedOrRNG?: Seed | RNG): float;
  * @param min The lower bound for the random number (inclusive).
  * @param max The upper bound for the random number (exclusive).
  * @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()`.
  */
 export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RNG): float;
 /**
@@ -27,7 +28,8 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
  * Note that this function will invoke the `Next` method on the `RNG` object before returning the
  * random number.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const oneTwoOrThree = getRandomInt(1, 3);
  * ```
@@ -35,6 +37,6 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
  * @param min The lower bound for the random number (inclusive).
  * @param max The upper bound for the random number (inclusive).
  * @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()`.
  */
 export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG): int;

package/dist/functions/rng.d.ts

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

package/dist/functions/rooms.d.ts

@@ -41,8 +41,9 @@ export declare function getRoomTypeName(roomType: RoomType): string;
  * the list.
  *
  * @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
- * `RoomList`. Default is false.
+ *                                     extra-dimensional rooms are automatically be generated and
+ *                                     can be seen when you iterate over the `RoomList`. Default is
+ *                                     false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
@@ -113,8 +114,8 @@ export declare function inStartingRoom(): boolean;
  * This function will only check rooms in the current dimension.
  *
  * @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
- * the array will be ignored. If not specified, then all rooms will be checked. Undefined by
- * default.
+ *                           the array will be ignored. If not specified, then all rooms will be
+ *                           checked. Undefined by default.
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[]): boolean;
 export declare function isDoorSlotValidAtGridIndex(doorSlot: DoorSlot, roomGridIndex: int): boolean;

package/dist/functions/set.d.ts

@@ -26,7 +26,7 @@ export declare function deleteSetsFromSet<T>(mainSet: Set<T>, ...setsToRemove: A
  *
  * @param set The set to get an element 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 getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;

package/dist/functions/spawnCollectible.d.ts

@@ -8,11 +8,11 @@ import { CollectibleType } from "isaac-typescript-definitions";
  * @param collectibleType The collectible type to spawn.
  * @param position The position to spawn the collectible at.
  * @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 options Optional. Set to true to make the collectible a "There's Options" style
- * collectible. Default is false.
+ *                collectible. Default is false.
  * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
- * Tainted Keeper. Default is false.
+ *                      Tainted Keeper. Default is false.
  */
 export declare function spawnCollectible(collectibleType: CollectibleType | int, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean): EntityPickup;
 /**
@@ -25,6 +25,6 @@ export declare function spawnCollectible(collectibleType: CollectibleType | int,
  *
  * @param position The position to spawn the empty collectible at.
  * @param seedOrRNG 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()`.
  */
 export declare function spawnEmptyCollectible(position: Vector, seedOrRNG?: Seed | RNG): EntityPickup;

package/dist/functions/transformations.d.ts

@@ -17,7 +17,8 @@ export declare function getPlayerTransformations(player: EntityPlayer): Set<Play
 /**
  * Helper function to get a transformation name from a PlayerForm enum.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const transformationName = getTransformationName(PlayerForm.LORD_OF_THE_FLIES);
  * // transformationName is "Beelzebub"

package/dist/functions/trinketGive.d.ts

@@ -14,7 +14,7 @@ export declare function giveTrinketsBack(player: EntityPlayer, trinketSituation:
  * @param player The player to smelt the trinkets to.
  * @param trinketType The trinket type to smelt.
  * @param numTrinkets Optional. If specified, will smelt the given number of trinkets. Use this to
- * avoid calling this function multiple times. Default is 1.
+ *                    avoid calling this function multiple times. Default is 1.
  */
 export declare function smeltTrinket(player: EntityPlayer, trinketType: TrinketType | int, numTrinkets?: number): void;
 /**

package/dist/functions/trinkets.d.ts

@@ -9,7 +9,8 @@ export declare function getGoldenTrinketType(trinketType: TrinketType | int): Tr
 /**
  * Returns the slot number corresponding to where a trinket can be safely inserted.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const player = Isaac.GetPlayer();
  * const trinketSlot = getOpenTrinketSlotNum(player);
@@ -29,7 +30,8 @@ export declare function getTrinketDescription(trinketType: TrinketType | int): s
  * Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
  * not valid.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const trinketType = TrinketType.SWALLOWED_PENNY;
  * const trinketName = getTrinketName(trinketType); // trinketName is "Swallowed Penny"
@@ -53,8 +55,9 @@ export declare function isGoldenTrinket(trinketType: TrinketType | int): boolean
  *
  * @param trinket The trinket whose sprite you want to modify.
  * @param pngPath Equal to either the spritesheet path to load (e.g.
- * "gfx/items/collectibles/collectibles_001_thesadonion.png") or undefined. If undefined, the sprite
- * will be removed, making it appear like the collectible has already been taken by the player.
+ *                "gfx/items/collectibles/collectibles_001_thesadonion.png") or undefined. If
+ *                undefined, the sprite will be removed, making it appear like the collectible has
+ *                already been taken by the player.
  */
 export declare function setTrinketSprite(trinket: EntityPickup, pngPath: string | undefined): void;
 export declare function trinketHasCacheFlag(trinketType: TrinketType | int, cacheFlag: CacheFlag): boolean;

package/dist/functions/ui.d.ts

@@ -6,8 +6,8 @@
  * offset setting so that mods can render UI elements to the screen in the correct position.
  *
  * @returns If the user does not have Mod Config Menu enabled, or does not have this option set,
- * then this function will return `Vector.Zero.` Otherwise, it will return a Vector that represents
- * a HUD offset that should be added to the position of a UI element.
+ *          then this function will return `Vector.Zero.` Otherwise, it will return a Vector that
+ *          represents a HUD offset that should be added to the position of a UI element.
  */
 export declare function getHUDOffsetVector(): Vector;
 /**

package/dist/functions/utils.d.ts

@@ -4,7 +4,8 @@
  *
  * Very useful to be future-safe against people adding values to a type or an enum.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * enum Situation {
  *   ONE,
@@ -80,7 +81,8 @@ export declare function printEnabled(enabled: boolean, description: string): voi
 /**
  * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const player = Isaac.GetPlayer();
  * repeat(10, () => {

package/dist/functions/vector.d.ts

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

package/dist/types/CollectibleIndex.d.ts

@@ -3,7 +3,8 @@
  * [[`getCollectibleIndex`]] function. Mods can signify that data structures handle collectibles by
  * using this type.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const collectiblesNameMap = new Map<CollectibleIndex, string>();
  * ```

package/dist/types/PlayerIndex.d.ts

@@ -3,7 +3,8 @@
  * PlayerIndex is a specific type of string; see the documentation for the [[`getPlayerIndex`]]
  * function. Mods can signify that data structures handle `EntityPlayer` by using this type.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const playersNameMap = new Map<PlayerIndex, string>();
  * ```

package/dist/upgradeMod.d.ts

@@ -3,7 +3,8 @@ import { ModUpgraded } from "./classes/ModUpgraded";
 /**
  * Use this function to enable the custom features and callbacks provided by `isaacscript-common`.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const modVanilla = RegisterMod("My Mod", 1);
  * const mod = upgradeMod(modVanilla);
@@ -15,9 +16,6 @@ import { ModUpgraded } from "./classes/ModUpgraded";
  * mod.AddCallbackCustom(ModCallbackCustom.POST_ITEM_PICKUP, postItemPickup);
  * ```
  *
- * 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.
  * @returns The upgraded mod object.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.0.11",
+  "version": "2.0.12",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -28,9 +28,10 @@
     "isaac-typescript-definitions": "^2.0.14"
   },
   "devDependencies": {
-    "isaacscript-lint": "^1.0.145",
+    "isaacscript-lint": "^1.0.150",
     "isaacscript-spell": "^1.0.3",
     "isaacscript-tsconfig": "^1.1.16",
+    "npm-check-updates": "^13.0.1",
     "ts-node": "^10.7.0",
     "typedoc": "^0.22.15",
     "typescript": "^4.6.4",