isaacscript-common 2.0.11 → 2.0.12

package/dist/classes/DefaultMap.d.ts

@@ -14,7 +14,8 @@ declare type SecondArg<K, V, A extends unknown[]> = V | FactoryFunction<K, V, A>
  * When instantiating a new DefaultMap, you must specify either a default value or a function that
  * returns a default value.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Initializes a new empty DefaultMap with a default value of "foo"
  * const defaultMapWithPrimitive = new DefaultMap<string, string>("foo");

package/dist/enums/ModCallbackCustom.d.ts

@@ -1,9 +1,6 @@
 /**
  * These are the custom callbacks available for use once the mod object has been upgraded. Also see
  * the [[`upgradeMod`]] function.
- *
- * For a better listing of all custom callbacks, check out the
- * [Function Signatures](https://isaacscript.github.io/docs/function-signatures#custom-callbacks).
  */
 export declare enum ModCallbackCustom {
     POST_BOMB_INIT_LATE = 0,

package/dist/features/deployJSONRoom.d.ts

@@ -7,17 +7,21 @@ import { JSONRoom } from "../types/JSONRoom";
  *
  * This function is meant to be used in the PostNewRoom callback.
  *
- * @param jsonRoom The JSON room to deploy. In practice, this will be something like:
+ * For example:
+ *
  * ```ts
+ *
  * import customRooms from "./customRooms";
  *
  * const firstJSONRoom = customRooms.rooms.room[0];
  * deployJSONRoom(firstJSONRoom);
  * ```
+ *
+ * @param jsonRoom The JSON room to deploy. *
  * @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 verbose Optional. If specified, will write entries to the "log.txt" file that describe
- * what the function is doing. Default is false.
+ *                what the function is doing. Default is false.
  */
 export declare function deployJSONRoom(jsonRoom: JSONRoom, seedOrRNG?: Seed | RNG, verbose?: boolean): void;
 /**
@@ -31,18 +35,21 @@ export declare function deployJSONRoom(jsonRoom: JSONRoom, seedOrRNG?: Seed | RN
  * properly account for each room weight using the algorithm from:
  * https://stackoverflow.com/questions/1761626/weighted-random-numbers
  *
- * @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be
- * something like:
+ * For example:
+ *
  * ```ts
  * import customRooms from "./customRooms";
  *
  * const jsonRooms = customRooms.rooms.room;
  * deployRandomJSONRoom(jsonRooms);
  * ```
+ *
+ * @param jsonRooms An array of JSON rooms to randomly select from. In practice, this will be
+ *                  something like.
  * @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 verbose Optional. If specified, will write entries to the "log.txt" file that describe
- * what the function is doing. Default is false.
+ *                what the function is doing. Default is false.
  */
 export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?: Seed | RNG, verbose?: boolean): void;
 /**
@@ -52,7 +59,7 @@ export declare function deployRandomJSONRoom(jsonRooms: JSONRoom[], seedOrRNG?:
  * effects (1000), doors, and walls.
  *
  * @param fillWithDecorations Optional. Set to true to fill every grid tile with an invisible
- * decoration, which prevents vanilla entities in the room from respawning the next time that the
- * player enters. Default is false.
+ *                            decoration, which prevents vanilla entities in the room from
+ *                            respawning the next time that the player enters. Default is false.
  */
 export declare function emptyRoom(fillWithDecorations: boolean): void;

package/dist/features/disableInputs.d.ts

@@ -4,7 +4,7 @@ import { ButtonAction } from "isaac-typescript-definitions";
  * used one of the other helper functions to disable inputs.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  */
 export declare function enableAllInputs(key: string): void;
 /**
@@ -14,7 +14,7 @@ export declare function enableAllInputs(key: string): void;
  * Use the [[`enableAllInputs`]] helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  */
 export declare function disableAllInputs(key: string): void;
 /**
@@ -24,7 +24,7 @@ export declare function disableAllInputs(key: string): void;
  * Use the [[`enableAllInputs`]] helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  * @param blacklist A set of ButtonActions to disallow.
  */
 export declare function enableAllInputsExceptFor(key: string, blacklist: Set<ButtonAction> | ReadonlySet<ButtonAction>): void;
@@ -35,7 +35,7 @@ export declare function enableAllInputsExceptFor(key: string, blacklist: Set<But
  * Use the [[`enableAllInputs`]] helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  * @param whitelist A set of ButtonActions to allow.
  */
 export declare function disableAllInputsExceptFor(key: string, whitelist: Set<ButtonAction>): void;
@@ -47,7 +47,7 @@ export declare function disableAllInputsExceptFor(key: string, whitelist: Set<Bu
  * Use the [[`enableAllInputs`]] helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  */
 export declare function disableMovementInputs(key: string): void;
 /**
@@ -57,6 +57,6 @@ export declare function disableMovementInputs(key: string): void;
  * Use the [[`enableAllInputs`]] helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  */
 export declare function disableShootingInputs(key: string): void;

package/dist/features/disableSound.d.ts

@@ -4,7 +4,7 @@
  * Use this function to set things back to normal after having used [[`disableAllSounds`]].
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  */
 export declare function enableAllSound(key: string): void;
 /**
@@ -13,6 +13,6 @@ export declare function enableAllSound(key: string): void;
  * Use the [[`enableAllSounds`]] helper function to set things back to normal.
  *
  * @param key The name of the mod feature that is requesting the enable/disable. This is needed so
- * that multiple mod features can work in tandem.
+ *            that multiple mod features can work in tandem.
  */
 export declare function disableAllSound(key: string): void;

package/dist/features/extraConsoleCommands/commands.d.ts

@@ -56,7 +56,7 @@ export declare function brokenHearts(params: string): void;
 /**
  * Gives the specified card. Accepts either the card sub-type or the partial name of the card.
  *
- * Example:
+ * For example:
  * - card 5 - Gives The Emperor.
  * - card spa - Gives 2 of Spades.
  */
@@ -71,7 +71,7 @@ export declare function chaosCardTears(): void;
  * Restart as the specified character. Accepts either the character sub-type or the partial name of
  * the character.
  *
- * Example:
+ * For example:
  * - character 2 - Restarts as Cain.
  * - character ta - Restarts as Tainted Azazel.
  */
@@ -224,9 +224,10 @@ export declare function oneHP(): void;
  * Gives a pill with the specified pill effect. Accepts either the effect ID or the partial name of
  * the effect.
  *
- * Example:
- * - pill 5 - Gives a Full Health pill.
- * - pill suns - Gives a Feels like I'm walking on sunshine! pill.
+ * For example:
+ *
+ * - `pill 5` - Gives a "Full Health" pill.
+ * - `pill suns` - Gives a "Feels like I'm walking on sunshine" pill.
  */
 export declare function pill(params: string): void;
 /** Spawns every pill on the ground, starting at the top-left-most tile. */
@@ -260,7 +261,7 @@ export declare function rottenHearts(params: string): void;
 /**
  * Alias for the "stage" command.
  *
- * Example:
+ * For example:
  * - s 3 - Warps to Caves 1.
  * - s 1c - Warps to Downpour 1.
  */
@@ -281,7 +282,7 @@ export declare function setCharges(params: string): void;
 /**
  * Moves the first player to the specified position.
  *
- * Example:
+ * For example:
  * - setposition 100 50
  */
 export declare function setPosition(params: string): void;
@@ -304,7 +305,7 @@ export declare function soulHearts(params: string): void;
 /**
  * Play the supplied sound effect.
  *
- * Example:
+ * For example:
  * - sound 1 - Plays the 1-Up sound effect.
  */
 export declare function sound(params: string): void;
@@ -337,7 +338,7 @@ export declare function up(params: string): void;
  * Warps to the specified room type. Accepts either the room type number or the partial name of the
  * room type.
  *
- * Example:
+ * For example:
  * - warp 5 - Warps to the first Boss Room on the floor, if any.
  * - warp tr - Warps to the first Treasure Room on the floor, if any.
  */

package/dist/features/runInNFrames.d.ts

@@ -24,7 +24,8 @@ export declare function runInNRenderFrames(func: () => void, renderFrames: int):
 /**
  * Supply a function to run on the next PostUpdate callback.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const NUM_EXPLODER_EXPLOSIONS = 5;
  *

package/dist/features/saveDataManager/exports.d.ts

@@ -71,14 +71,16 @@ import { SaveData } from "../../types/private/SaveData";
  * data.) For these cases, set a special key of "dontSave" alongside "run", "level", and so forth.
  *
  * @param key The name of the file or feature that is submitting data to be managed by the save data
- * manager. The save data manager will throw an error if the key is already registered.
+ *            manager. The save data manager will throw an error if the key is already registered.
  * @param v An object that corresponds to the `SaveData` interface. The object is conventionally
- * called "v" for brevity. ("v" is short for "local variables").
+ *          called "v" for brevity. ("v" is short for "local variables").
  * @param conditionalFunc An optional function to run upon saving this key to disk. For example,
- * this allows features to only save data to disk if the feature is enabled. Specify a value of `()
- * => false` to completely disable saving this feature to disk. This is useful if you are using data
- * that is not serializable, or you want to use the save data manager to automatically reset
- * variables on run/level/room, but not clutter the the "save#.dat" file with unnecessary keys.
+ *                        this allows features to only save data to disk if the feature is enabled.
+ *                        Specify a value of `() => false` to completely disable saving this feature
+ *                        to disk. This is useful if you are using data that is not serializable, or
+ *                        you want to use the save data manager to automatically reset variables on
+ *                        run/level/room, but not clutter the the "save#.dat" file with unnecessary
+ *                        keys.
  */
 export declare function saveDataManager(key: string, v: SaveData, conditionalFunc?: () => boolean): void;
 /**

package/dist/features/sirenHelpers.d.ts

@@ -5,7 +5,7 @@ import { FamiliarVariant } from "isaac-typescript-definitions";
  *
  * @param familiarVariant The familiar variant to blacklist.
  * @param familiarSubType The sub-type to blacklist. Optional. The default is to blacklist all
- * sub-types of the given variant.
+ *                        sub-types of the given variant.
  */
 export declare function setFamiliarNoSirenSteal(familiarVariant: FamiliarVariant | int, familiarSubType?: int): void;
 /**

package/dist/functions/array.d.ts

@@ -49,14 +49,14 @@ export declare function combineArrays<T>(...arrays: Array<T[] | readonly T[]>):
  *
  * @param oldArray The array to copy.
  * @param numElements Optional. If specified, will only copy the first N elements. By default, the
- * entire array will be copied.
+ *                    entire array will be copied.
  */
 export declare function copyArray<T>(oldArray: T[] | readonly T[], numElements?: int): T[];
 export declare function emptyArray<T>(array: T[]): void;
 /**
  * Helper function to get an array containing the indexes of an array.
  *
- * For example, an array of `["Apple", "Banana"]` would return an array of: `[0, 1]`
+ * For example, an array of `["Apple", "Banana"]` would return an array of `[0, 1]`.
  */
 export declare function getArrayIndexes<T>(array: T[] | readonly T[]): int[];
 /**
@@ -70,7 +70,7 @@ export declare function getLastElement<T>(array: T[]): T | undefined;
  *
  * @param array The array 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 getRandomArrayElement<T>(array: T[] | readonly T[], seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;
@@ -80,7 +80,7 @@ export declare function getRandomArrayElement<T>(array: T[] | readonly T[], seed
  *
  * @param array The array 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 getRandomArrayElementAndRemove<T>(array: T[], seedOrRNG?: Seed | RNG, exceptions?: T[] | readonly T[]): T;
@@ -89,13 +89,14 @@ export declare function getRandomArrayElementAndRemove<T>(array: T[], seedOrRNG?
  *
  * @param array The array to get the index 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()`.
  */
 export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOrRNG?: Seed | RNG): int;
 /**
  * Initializes an array with all elements containing the specified default value.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const playerTransformations = initArray(false, PlayerForm.NUM_PLAYER_FORMS - 1);
  * ```
@@ -103,7 +104,7 @@ export declare function getRandomArrayIndex<T>(array: T[] | readonly T[], seedOr
 export declare function initArray<T>(defaultValue: T, size: int): T[];
 /**
  * Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a
- * particular table is being used as an array. isArray returns true if:
+ * particular table is being used as an array. `isArray` returns true if:
  *
  * - the table contains all numerical indexes that are contiguous, starting at 1
  * - the table has no keys (i.e. an "empty" table)
@@ -124,7 +125,7 @@ export declare function isArrayInArray<T>(arrayToMatch: T[] | readonly T[], pare
  *
  * @param originalArray The array to shuffle.
  * @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 shuffleArray<T>(originalArray: T[] | readonly T[], seedOrRNG?: Seed | RNG): T[];
 /**
@@ -134,7 +135,7 @@ export declare function shuffleArray<T>(originalArray: T[] | readonly T[], seedO
  *
  * @param array The array to shuffle.
  * @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 shuffleArrayInPlace<T>(array: T[], seedOrRNG?: Seed | RNG): void;
 export declare function sumArray(array: number[] | readonly number[]): number;

package/dist/functions/benchmark.d.ts

@@ -5,6 +5,6 @@
  * This function is variadic, which means that you can supply as many as you want to benchmark.
  *
  * @returns An array containing the average time in milliseconds for each function. (This will also
- * be printed to the log.)
+ *          be printed to the log.)
  */
 export declare function benchmark(numTrials: int, ...functions: Array<() => void>): int[];

package/dist/functions/cards.d.ts

@@ -2,7 +2,8 @@ import { Card, ItemConfigCardType } from "isaac-typescript-definitions";
 /**
  * Helper function to get a card description from a Card enum value.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const card = Card.FOOL;
  * const cardDescription = getCardDescription(card); // cardDescription is "Where journey begins"
@@ -12,7 +13,8 @@ export declare function getCardDescription(card: Card | int): string;
 /**
  * Helper function to get a card name from a Card.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const card = Card.FOOL;
  * const cardName = getCardName(card); // cardName is "0 - The Fool"
@@ -37,14 +39,14 @@ export declare function getCardsOfType(...cardTypes: ItemConfigCardType[]): Set<
  *   runes/objects)
  *
  * @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 cards to not select.
  */
 export declare function getRandomCard(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
 /**
  * @param cardType The card type that represents the pool of cards to select 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 cards to not select.
  */
 export declare function getRandomCardOfType(cardType: ItemConfigCardType, seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;
@@ -53,7 +55,7 @@ export declare function getRandomCardOfType(cardType: ItemConfigCardType, seedOr
  * Isaac, etc.). This will never return a Rune Shard.
  *
  * @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 runes to not select.
  */
 export declare function getRandomRune(seedOrRNG?: Seed | RNG, exceptions?: Card[]): Card;

package/dist/functions/charge.d.ts

@@ -10,7 +10,8 @@ import { ActiveSlot } from "isaac-typescript-definitions";
  *
  * @param player The player to grant the charges to.
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
+ *                                  1x1 room for the purposes of calculating how much charge to
+ *                                  grant. Default is false.
  */
 export declare function addRoomClearCharge(player: EntityPlayer, ignoreBigRoomDoubleCharge?: boolean): void;
 /**
@@ -25,7 +26,8 @@ export declare function addRoomClearCharge(player: EntityPlayer, ignoreBigRoomDo
  * @param player The player to grant the charges to.
  * @param activeSlot The active item slot to grant the charges to.
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
+ *                                  1x1 room for the purposes of calculating how much charge to
+ *                                  grant. Default is false.
  */
 export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, ignoreBigRoomDoubleCharge?: boolean): void;
 /**
@@ -38,7 +40,8 @@ export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlo
  * - AAA Battery
  *
  * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
- * 1x1 room for the purposes of calculating how much charge to grant. Default is false.
+ *                                  1x1 room for the purposes of calculating how much charge to
+ *                                  grant. Default is false.
  */
 export declare function addRoomClearCharges(ignoreBigRoomDoubleCharge?: boolean): void;
 /**

package/dist/functions/collectibles.d.ts

@@ -76,7 +76,8 @@ export declare function getCollectibleMaxCharges(collectibleType: CollectibleTyp
  * Helper function to get the name of a collectible. Returns "Unknown" if the provided collectible
  * type is not valid.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const collectibleType = CollectibleType.SAD_ONION;
  * const collectibleName = getCollectibleName(collectibleType); // collectibleName is "Sad Onion"
@@ -93,7 +94,8 @@ export declare function getCollectibleQuality(collectibleType: CollectibleType |
  * Helper function to get the tags of a collectible (which is the composition of zero or more
  * `ItemConfigTag`). Returns 0 if the provided collectible type is not valid.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const collectibleType = CollectibleType.SAD_ONION;
  * const itemConfigTags = getCollectibleTags(collectibleType); // itemConfigTags is "18350080"
@@ -155,8 +157,9 @@ export declare function setCollectibleEmpty(collectible: EntityPickup): void;
  *
  * @param collectible The collectible 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 setCollectibleSprite(collectible: EntityPickup, pngPath: string | undefined): void;
 /**

package/dist/functions/color.d.ts

@@ -14,7 +14,7 @@ export declare function colorEquals(color1: Color, color2: Color): boolean;
  * Helper function to copy a `Color` object.
  *
  * @param color The Color object to copy. In the case of deserialization, this will actually be a
- * Lua table instead of an instantiated Color class.
+ *              Lua table instead of an instantiated Color class.
  * @param serializationType Default is `SerializationType.NONE`.
  */
 export declare function copyColor<C extends Color | SerializedColor, S extends SerializationType>(color: C, serializationType: S): CopyColorReturn[S];

package/dist/functions/deepCopy.d.ts

@@ -22,7 +22,8 @@ import { SerializationType } from "../enums/SerializationType";
  *
  * @param value The primitive or object to copy.
  * @param serializationType Has 3 possible values. Can leave objects as-is, or can serialize objects
- * to Lua tables, or can deserialize Lua tables to objects. Default is `SerializationType.NONE`.
+ *                          to Lua tables, or can deserialize Lua tables to objects. Default is
+ *                          `SerializationType.NONE`.
  * @param traversalDescription Used to track the current key that we are operating on.
  */
 export declare function deepCopy(value: unknown, serializationType?: SerializationType, traversalDescription?: string): unknown;

package/dist/functions/entity.d.ts

@@ -15,7 +15,8 @@ export declare function countEntities(entityType?: EntityType | int, variant?: n
  * Given an array of entities, this helper function returns the closest one to a provided reference
  * entity.
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * const player = Isaac.GetPlayer();
  * const gapers = getEntities(EntityType.GAPER);
@@ -31,7 +32,8 @@ export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity:
  * expensive but also more robust. (If a matching entity type is provided, then `Isaac.FindByType`
  * will be used instead.)
  *
- * Example:
+ * For example:
+ *
  * ```ts
  * // Make all of the entities in the room invisible
  * for (const entity of getEntities()) {
@@ -41,11 +43,12 @@ export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity:
  *
  * @param entityType Optional. If specified, will only return NPCs that match this entity type.
  * @param variant Optional. If specified, will only return NPCs that match this variant. Default is
- * -1. -1 matches every variant.
+ *                -1. -1 matches every variant.
  * @param subType Optional. If specified, will only return NPCs that match this sub-type. Default is
- * -1. -1 matches every sub-type.
+ *                -1. -1 matches every sub-type.
  * @param ignoreFriendly Optional. If set to true, it will exclude friendly NPCs from being
- * returned. Default is false. Will only be taken into account if `matchingEntityType` is specified.
+ *                       returned. Default is false. Will only be taken into account if
+ *                       `matchingEntityType` is specified.
  */
 export declare function getEntities(entityType?: EntityType | int, variant?: number, subType?: number, ignoreFriendly?: boolean): Entity[];
 /** Helper function to return a string containing the entity's type, variant, and sub-type. */
@@ -110,7 +113,7 @@ export declare function removeEntities(entities: Entity[], cap?: int): boolean;
  *
  * @param entity The entity to reroll.
  * @returns If the game failed to reroll the enemy, returns undefined. Otherwise, returns the
- * rerolled entity.
+ *          rerolled entity.
  */
 export declare function rerollEnemy(entity: Entity): Entity | undefined;
 export declare function setEntityRandomColor(entity: Entity): void;

package/dist/functions/entity.lua

@@ -164,7 +164,7 @@ function ____exports.rerollEnemy(self, entity)
     local newEntities = ____exports.getEntities(nil)
     local filteredNewEntities = ____exports.getFilteredNewEntities(nil, oldEntities, newEntities)
     if #filteredNewEntities == 0 then
-        error("Failed to find the new entity generated by the \"RerollEnemy\" method.")
+        error("Failed to find the new entity generated by the \"Game.RerollEnemy\" method.")
     end
     return filteredNewEntities[1]
 end

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()) {
@@ -15,7 +16,8 @@ export declare function getBombs(bombVariant?: BombVariant | int, subType?: numb
 /**
  * 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()) {
@@ -27,7 +29,8 @@ export declare function getEffects(effectVariant?: EffectVariant | int, subType?
 /**
  * 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()) {
@@ -39,7 +42,8 @@ export declare function getFamiliars(familiarVariant?: FamiliarVariant | int, su
 /**
  * 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()) {
@@ -51,7 +55,8 @@ export declare function getKnives(knifeVariant?: KnifeVariant | int, subType?: n
 /**
  * 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()) {
@@ -65,7 +70,8 @@ export declare function getNPCs(entityType?: EntityType | int, variant?: int, su
 /**
  * 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()) {
@@ -77,7 +83,8 @@ export declare function getPickups(pickupVariant?: PickupVariant | int, subType?
 /**
  * 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()) {
@@ -89,7 +96,8 @@ export declare function getProjectiles(projectileVariant?: ProjectileVariant | i
 /**
  * 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()) {
@@ -101,7 +109,8 @@ export declare function getSlots(slotVariant?: SlotVariant | int, subType?: numb
 /**
  * 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()) {
@@ -132,7 +141,7 @@ export declare function removeAllEffects(effectVariant?: EffectVariant | int, su
  * 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.
@@ -176,7 +185,7 @@ export declare function removeAllPickups(pickupVariant?: PickupVariant | int, su
  * 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.