isaacscript-common 9.13.4 → 9.13.5-dev.0

package/dist/index.d.ts

@@ -287,6 +287,7 @@ export declare function addRoomClearCharges(bigRoomDoubleCharge?: boolean): void
  */
 export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, bigRoomDoubleCharge?: boolean, playSoundEffect?: boolean): void;
 
+/** @noSelfInFile */
 /**
  * Helper function to add all of the values in one set to another set. The first set passed will be
  * modified in place.
@@ -295,6 +296,7 @@ export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlo
  */
 export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T> | ReadonlySet<T>>): void;
 
+/** @noSelfInFile */
 /**
  * - Converts the specified amount of tears stat into the format of `EntityPlayer.MaxFireDelay` and
  *   adds it to the player.
@@ -317,6 +319,7 @@ export declare const ALL_DISPLAY_FLAGS: BitFlags<number & {
     readonly __displayFlagBrand: symbol;
 }>;
 
+/** @noSelfInFile */
 /** This is used by the `POST_AMBUSH_STARTED` and `POST_AMBUSH_FINISHED` custom callbacks. */
 export declare enum AmbushType {
     CHALLENGE_ROOM = 0,
@@ -332,6 +335,7 @@ export declare enum AmbushType {
  */
 export declare function angleToDirection(angleDegrees: int): Direction;
 
+/** @noSelfInFile */
 /**
  * A type union that matches `Entity`, `EntityBomb`, `EntityEffect`, and so on.
  *
@@ -339,8 +343,10 @@ export declare function angleToDirection(angleDegrees: int): Direction;
  */
 export declare type AnyEntity = Entity | EntityBomb | EntityEffect | EntityFamiliar | EntityKnife | EntityLaser | EntityNPC | EntityPickup | EntityPlayer | EntityProjectile | EntityTear;
 
+/** @noSelfInFile */
 export declare function anyEntityCloserThan(entities: Entity[], position: Vector, distance: int): boolean;
 
+/** @noSelfInFile */
 /**
  * A type union that matches `GridEntity`, `GridEntityDoor`, `GridEntityPit`, and so on.
  *
@@ -374,6 +380,7 @@ export declare function anyPlayerIs(...matchingCharacters: PlayerType[]): boolea
  */
 export declare function anyPlayerUsingPony(): boolean;
 
+/** @noSelfInFile */
 /**
  * Helper function for determining if two arrays contain the exact same elements. Note that this
  * only performs a shallow comparison.
@@ -454,6 +461,7 @@ export declare function arrayRemoveIndexInPlace<T>(array: T[], ...indexesToRemov
  */
 export declare function arrayRemoveInPlace<T>(array: T[], ...elementsToRemove: T[]): boolean;
 
+/** @noSelfInFile */
 /** Helper function to convert a set of flags to a single `BitFlags` object. */
 export declare function arrayToBitFlags<T extends BitFlag | BitFlag128>(array: T[] | readonly T[]): BitFlags<T>;
 
@@ -545,6 +553,7 @@ export declare function asTrinketType(num: number): TrinketType;
  */
 export declare const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE = 75.125;
 
+/** @noSelfInFile */
 /**
  * Helper function to benchmark the performance of a function.
  *
@@ -613,6 +622,7 @@ export declare function canPlayerCrushRocks(player: EntityPlayer): boolean;
  */
 export declare function canRunUnlockAchievements(): boolean;
 
+/** @noSelfInFile */
 export declare function capitalizeFirstLetter(string: string): string;
 
 /** Maps card names to card sub-types. */
@@ -664,6 +674,7 @@ export declare function characterGetsBlackHeartFromEternalHeart(character: Playe
  */
 export declare function characterStartsWithActiveItem(character: PlayerType): boolean;
 
+/** @noSelfInFile */
 /**
  * A collection of the four sprites necessary in order to render a charge bar.
  *
@@ -755,6 +766,7 @@ export declare function clearCollectibleSprite(collectible: EntityPickup): void;
  */
 export declare function clearFloorDisplayFlags(): void;
 
+/** @noSelfInFile */
 /**
  * Helper function to clear all layers or specific layers from a sprite.
  *
@@ -769,6 +781,7 @@ export declare function clearFloorDisplayFlags(): void;
  */
 export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
 
+/** @noSelfInFile */
 /**
  * In a `Map`, you can use the `clear` method to delete every element. However, in a `LuaMap`, the
  * `clear` method does not exist. Use this helper function as a drop-in replacement for this.
@@ -791,6 +804,7 @@ export declare function collectibleHasCacheFlag(collectibleType: CollectibleType
 
 export declare function collectibleHasTag(collectibleType: CollectibleType, tag: ItemConfigTag): boolean;
 
+/** @noSelfInFile */
 /**
  * `CollectibleIndex` is a specific type of string that represents a unique identifier for a
  * collectible. Mods can signify that data structures handle collectibles by using this type.
@@ -917,6 +931,7 @@ export declare function copyIsaacAPIClass(isaacAPIClass: unknown): unknown;
 /** Helper function to copy a `KColor` Isaac API class. */
 export declare function copyKColor(kColor: KColor): KColor;
 
+/** @noSelfInFile */
 /** Helper function to copy a map. (You can also use a Map constructor to accomplish this task.) */
 export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
 
@@ -942,6 +957,7 @@ export declare interface Corner {
     readonly position: Readonly<Vector>;
 }
 
+/** @noSelfInFile */
 /** This is used by the `getRoomShapeCorners` helper function. */
 export declare enum CornerType {
     TOP_LEFT = 0,
@@ -1075,17 +1091,7 @@ export declare interface CustomStageShadow {
     };
 }
 
-/**
- * This is the format of a custom stage in the "isaacscript" section of the "tsconfig.json" file.
- *
- * The contents of this interface are used to create a "tsconfig-isaacscript-section-schema.json"
- * schema with the "ts-json-schema-generator" library.
- *
- * The contents of this interface are validated at run-time against the schema using the Ajv
- * library.
- *
- * The `CustomStageLua` interface extends this, adding room metadata.
- */
+/** @noSelfInFile */
 export declare interface CustomStageTSConfig {
     /** Mandatory. The name of the custom stage. */
     name: string;
@@ -1529,6 +1535,7 @@ export declare const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
 
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
 
+/** @noSelfInFile */
 /**
  * `DefaultMap` is a data structure that makes working with default values easier. It extends a
  * `Map` and adds additional methods.
@@ -1951,6 +1958,7 @@ export declare function easeInQuart(x: number): number;
 
 export declare function easeInQuint(x: number): number;
 
+/** @noSelfInFile */
 export declare function easeInSine(x: number): number;
 
 export declare function easeOutBack(x: number): number;
@@ -2022,6 +2030,7 @@ export declare function enableAllInputs(key: string): void;
  */
 export declare function enableAllInputsExceptFor(key: string, blacklist: Set<ButtonAction> | ReadonlySet<ButtonAction>): void;
 
+/** @noSelfInFile */
 /**
  * Helper function to stop muting all sound effects and music.
  *
@@ -2058,6 +2067,7 @@ export declare function enableDevFeatures(mod: ModUpgraded): void;
  */
 export declare function enableExtraConsoleCommands(mod: ModUpgraded): void;
 
+/** @noSelfInFile */
 /**
  * Enables the fast-reset feature, which allows you to restart the game instantaneously. If this
  * behavior is desired, call this function once at the beginning of your mod.
@@ -2068,6 +2078,7 @@ export declare function enableExtraConsoleCommands(mod: ModUpgraded): void;
  */
 export declare function enableFastReset(): void;
 
+/** @noSelfInFile */
 /**
  * Helper function to return an array with the elements from start to end. It is inclusive at the
  * start and exclusive at the end. (The "e" stands for exclusive.)
@@ -2089,6 +2100,7 @@ declare type ErrorIsaacAPIClassIsNotSerializable = "Error: Isaac API classes (su
  */
 export declare type FactoryFunction<V, Args extends unknown[]> = (...args: Args) => V;
 
+/** @noSelfInFile */
 export declare function fillLevelWithRedRooms(): void;
 
 /**
@@ -2206,6 +2218,7 @@ export declare function forceNewLevelCallback(): void;
  */
 export declare function forceNewRoomCallback(): void;
 
+/** @noSelfInFile */
 /**
  * When used on The Forgotten, switches to The Soul. When used on The Soul, switches to The
  * Forgotten. This takes 1 game frame to take effect.
@@ -2436,6 +2449,7 @@ export declare function getBlueWombDoor(): GridEntityDoor | undefined;
  */
 export declare function getBombPickups(bombSubType?: BombSubType): EntityPickupBomb[];
 
+/** @noSelfInFile */
 /** Helper function to find out how large a bomb explosion is based on the damage inflicted. */
 export declare function getBombRadiusFromDamage(damage: float): float;
 
@@ -2858,6 +2872,7 @@ export declare function getCustomGridEntityType(gridEntityOrGridIndex: GridEntit
  */
 export declare function getDebugPrependString(msg: string, numParentFunctions?: number): string;
 
+/** @noSelfInFile */
 /**
  * Helper function to get a set containing all of the global variable names that are contained
  * within the Isaac environment by default.
@@ -3037,6 +3052,7 @@ export declare function getEntityPositions(entities?: Entity[]): Map<PtrHash, Ve
  */
 export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, Vector>;
 
+/** @noSelfInFile */
 /**
  * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
  * when you iterate over them, you will get both the names of the enums and the values of the enums,
@@ -3314,6 +3330,7 @@ export declare function getHorsePillColor(pillColor: PillColor): PillColor;
 /** Helper function to get an array with every non-gold horse pill color. */
 export declare function getHorsePillColors(): PillColor[];
 
+/** @noSelfInFile */
 /**
  * In the options menu, players have the ability to set a HUD offset. However, mods do not have
  * access to this value. To get around this, Mod Config Menu provides a separate HUD offset setting
@@ -3326,6 +3343,7 @@ export declare function getHorsePillColors(): PillColor[];
  */
 export declare function getHUDOffsetVector(): Vector;
 
+/** @noSelfInFile */
 /**
  * Helper function to get the name of a class from the Isaac API. This is contained within the
  * "__type" metatable key.
@@ -3396,6 +3414,7 @@ export declare function getKeys(keySubType?: KeySubType): EntityPickupKey[];
  */
 export declare function getKnives(knifeVariant?: KnifeVariant, subType?: number): EntityKnife[];
 
+/** @noSelfInFile */
 /**
  * Helper function to convert the language abbreviation from `Options.Language` to the "full"
  * language name.
@@ -4271,6 +4290,7 @@ export declare function getPreviousRoomDescription(): RoomDescription;
  */
 export declare function getProjectiles(projectileVariant?: ProjectileVariant, subType?: number): EntityProjectile[];
 
+/** @noSelfInFile */
 /**
  * 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 the `RNG.RandomFloat` method will never return a value of exactly 1.)
@@ -4527,6 +4547,7 @@ export declare function getRoomAdjacentGridIndexes(roomGridIndex?: int): Map<Doo
  */
 export declare function getRoomAllowedDoors(roomGridIndex?: int): Set<DoorSlot>;
 
+/** @noSelfInFile */
 /**
  * Helper function to get the game frame (i.e. `Game.GetFrameCount`) of the last time that this room
  * was cleared. Returns undefined if the room has never been cleared.
@@ -4948,6 +4969,7 @@ stageType: StageType
 /** Alias for the `Level.GetStageType` method. */
 export declare function getStageType(): StageType;
 
+/** @noSelfInFile */
 /** Alias for the `Seeds.GetStartSeedString` method. */
 export declare function getStartSeedString(): string;
 
@@ -4968,6 +4990,7 @@ export declare function getSubPlayerParent(subPlayer: EntitySubPlayer): EntityPl
 
 export declare function getSurroundingGridEntities(gridEntity: GridEntity): GridEntity[];
 
+/** @noSelfInFile */
 /**
  * Helper function to get the other version of Tainted Lazarus.
  *
@@ -5366,6 +5389,7 @@ export declare function hasSirenStolenFamiliar(familiar: EntityFamiliar): boolea
  */
 export declare function hasVisitedStage(stage: LevelStage, stageType?: StageType): boolean;
 
+/** @noSelfInFile */
 /**
  * This represents the type of health that is either given or taken away from a player. Note that we
  * cannot use the `HeartSubType` enum for this purpose this since it has no value for broken hearts
@@ -5383,6 +5407,7 @@ export declare enum HealthType {
     MAX_HEARTS = 8
 }
 
+/** @noSelfInFile */
 /**
  * Converts a hex string like "#33aa33" to a KColor object.
  *
@@ -5397,6 +5422,7 @@ export declare function hexToColor(hexString: string, alpha: float): Color;
  */
 export declare function hexToKColor(hexString: string, alpha: float): KColor;
 
+/** @noSelfInFile */
 /**
  * Immutable is a utility type that will make the given array/map/set/object recursively read-only.
  *
@@ -5460,6 +5486,7 @@ export declare function inDoubleTrouble(): boolean;
 
 export declare function inGenesisRoom(): boolean;
 
+/** @noSelfInFile */
 /**
  * Initializes an array with all of the elements containing the specified default value.
  *
@@ -5598,6 +5625,7 @@ export declare function isActiveSlotEmpty(player: EntityPlayer, activeSlot: Acti
  */
 export declare function isAliveExceptionNPC(npc: EntityNPC): boolean;
 
+/** @noSelfInFile */
 /**
  * Helper function to check if all of the pressure plates in the room are pushed.
  *
@@ -5765,6 +5793,7 @@ export declare function isDaddyLongLegsChildStompEntity(npc: EntityNPC): boolean
  */
 export declare function isDamageFromPlayer(damageSource: Entity): boolean;
 
+/** @noSelfInFile */
 /**
  * Uses the player's current health and other miscellaneous things to determine if incoming damage
  * will be fatal.
@@ -5931,6 +5960,7 @@ export declare function isGridEntityBreakableByExplosion(gridEntity: GridEntity)
  */
 export declare function isGridEntityBroken(gridEntity: GridEntity): boolean;
 
+/** @noSelfInFile */
 /** For `PickupVariant.HEART` (10). */
 export declare function isHeart(pickup: EntityPickup): pickup is EntityPickupHeart;
 
@@ -6083,6 +6113,7 @@ export declare function isPit(variable: unknown): variable is GridEntityPit;
 /** Helper function to detect if a variable is of type `EntityPlayer`. */
 export declare function isPlayer(variable: unknown): variable is EntityPlayer;
 
+/** @noSelfInFile */
 /**
  * Helper function to see if the player is under the effects of A Pony or White Pony charge.
  * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
@@ -6254,6 +6285,7 @@ export declare function isSin(npc: EntityNPC): boolean;
  */
 export declare function isSingleUseCollectible(collectibleType: CollectibleType): boolean;
 
+/** @noSelfInFile */
 /** For `EntityType.SLOT` (6). */
 export declare function isSlot(entity: Entity): entity is EntitySlot;
 
@@ -6382,6 +6414,7 @@ export declare const itemConfig: ItemConfig;
  */
 export declare function iterateTableInOrder<K, V>(luaMap: LuaMap<K, V>, func: (key: K, value: V) => void, inOrder?: boolean): void;
 
+/** @noSelfInFile */
 /**
  * Converts a JSON string to a Lua table.
  *
@@ -6463,6 +6496,7 @@ export declare interface JSONRooms {
     room: JSONRoom[];
 }
 
+/** @noSelfInFile */
 /**
  * The standard library has the feature to deploy a new room on-the-fly with the `deployJSONRoom`
  * helper function. It requires a `JSONRoomsFile` as an argument, which is simply an XML file
@@ -6809,6 +6843,7 @@ export declare const MIN_PLAYER_SPEED_STAT = 0.1;
 
 export declare const MINUTE_IN_MILLISECONDS: number;
 
+/** @noSelfInFile */
 /**
  * - The Isaac API offers a lot of callbacks, but a lot of times there isn't one for the specific
  *   thing that you are looking to do. So, `isaacscript-common` adds a bunch of new callbacks that
@@ -8263,6 +8298,7 @@ export declare class ModUpgraded implements Mod {
     AddCallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...args: AddCallbackParameterCustom[T]): void;
 }
 
+/** @noSelfInFile */
 /**
  * Helper function to move all of the players to where they would normally go when arriving at a new
  * floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
@@ -8458,6 +8494,7 @@ export declare function parseEntityID(entityID: string): [entityType: EntityType
  */
 export declare function parseEntityTypeVariantString(entityTypeVariantString: string): [entityType: EntityType, variant: int] | undefined;
 
+/** @noSelfInFile */
 /**
  * Helper function to emulate what happens when the player pauses the game. Use the `unpause`
  * function to return things back to normal.
@@ -8494,6 +8531,7 @@ export declare interface PickingUpItemTrinket {
     subType: TrinketType;
 }
 
+/** @noSelfInFile */
 /**
  * `PickupIndex` is a specific type of number that represents a unique identifier for a pickup. Mods
  * can signify that data structures handle collectibles by using this type.
@@ -8562,6 +8600,7 @@ export declare interface PlayerHealth {
     soulHeartTypes: SoulHeartType[];
 }
 
+/** @noSelfInFile */
 /**
  * `PlayerIndex` is a specific type of number that represents a unique identifier for a player. Mods
  * can signify that data structures handle `EntityPlayer` by using this type.
@@ -8587,6 +8626,7 @@ export declare interface PocketItemDescription {
     subType: int;
 }
 
+/** @noSelfInFile */
 /** This is used in the various pocket item helper functions. */
 export declare enum PocketItemType {
     EMPTY = 0,
@@ -8623,6 +8663,7 @@ callback: (bomb: EntityBomb) => void,
 bombVariant?: BombVariant
 ];
 
+/** @noSelfInFile */
 declare type PostBoneSwingRegisterParameters = [
 callback: (boneClub: EntityKnife) => void
 ];
@@ -8637,6 +8678,7 @@ callback: (collectible: EntityPickup) => void,
 collectibleType?: CollectibleType
 ];
 
+/** @noSelfInFile */
 declare type PostCursedTeleportRegisterParameters = [
 callback: (player: EntityPlayer) => void
 ];
@@ -8646,6 +8688,7 @@ callback: (player: EntityPlayer, effectVariant: int, doorSlot: DoorSlot, directi
 effectVariant?: int
 ];
 
+/** @noSelfInFile */
 declare type PostCustomReviveRegisterParameters = [
 callback: (player: EntityPlayer, revivalType: int) => void,
 revivalType?: int
@@ -8676,6 +8719,7 @@ callback: (effect: EntityEffect, previousState: int, currentState: int) => void,
 effectVariant?: EffectVariant
 ];
 
+/** @noSelfInFile */
 declare type PostEsauJrRegisterParameters = [
 callback: (player: EntityPlayer) => void
 ];
@@ -8690,26 +8734,32 @@ callback: (familiar: EntityFamiliar, previousState: int, currentState: int) => v
 familiarVariant?: FamiliarVariant
 ];
 
+/** @noSelfInFile */
 declare type PostFirstEsauJrRegisterParameters = [
 callback: (player: EntityPlayer) => void
 ];
 
+/** @noSelfInFile */
 declare type PostFirstFlipRegisterParameters = [
 callback: (newLazarus: EntityPlayer, oldLazarus: EntityPlayer) => void
 ];
 
+/** @noSelfInFile */
 declare type PostFlipRegisterParameters = [
 callback: (newLazarus: EntityPlayer, oldLazarus: EntityPlayer) => void
 ];
 
+/** @noSelfInFile */
 declare type PostGameStartedReorderedLastRegisterParameters = [
 callback: (isContinued: boolean) => void
 ];
 
+/** @noSelfInFile */
 declare type PostGameStartedReorderedRegisterParameters = [
 callback: (isContinued: boolean) => void
 ];
 
+/** @noSelfInFile */
 declare type PostGreedModeWaveRegisterParameters = [
 callback: (oldWave: int, newWave: int) => void
 ];
@@ -8826,10 +8876,13 @@ callback: (laser: EntityLaser) => void,
 laserVariant?: LaserVariant
 ];
 
+/** @noSelfInFile */
 declare type PostNewLevelReorderedRegisterParameters = [callback: () => void];
 
+/** @noSelfInFile */
 declare type PostNewRoomEarlyRegisterParameters = [callback: () => void];
 
+/** @noSelfInFile */
 declare type PostNewRoomReorderedRegisterParameters = [callback: () => void];
 
 declare type PostNPCInitLateRegisterParameters = [
@@ -8967,16 +9020,19 @@ pickupVariant?: PickupVariant,
 pickupSubType?: int
 ];
 
+/** @noSelfInFile */
 declare type PostRockRenderRegisterParameters = [
 callback: (rock: GridEntityRock) => void,
 gridEntityVariant?: int
 ];
 
+/** @noSelfInFile */
 declare type PostRockUpdateRegisterParameters = [
 callback: (rock: GridEntityRock) => void,
 gridEntityVariant?: int
 ];
 
+/** @noSelfInFile */
 declare type PostRoomClearChangedRegisterParameters = [
 callback: (roomClear: boolean) => void,
 roomClear?: boolean
@@ -9019,11 +9075,13 @@ callback: (slot: EntitySlot) => void,
 slotVariant?: SlotVariant
 ];
 
+/** @noSelfInFile */
 declare type PostSpikesRenderRegisterParameters = [
 callback: (spikes: GridEntitySpikes) => void,
 gridEntityVariant?: int
 ];
 
+/** @noSelfInFile */
 declare type PostSpikesUpdateRegisterParameters = [
 callback: (spikes: GridEntitySpikes) => void,
 gridEntityVariant?: int
@@ -9039,11 +9097,13 @@ callback: (tear: EntityTear) => void,
 tearVariant?: TearVariant
 ];
 
+/** @noSelfInFile */
 declare type PostTNTRenderRegisterParameters = [
 callback: (tnt: GridEntityTNT) => void,
 gridEntityVariant?: int
 ];
 
+/** @noSelfInFile */
 declare type PostTNTUpdateRegisterParameters = [
 callback: (tnt: GridEntityTNT) => void,
 gridEntityVariant?: int
@@ -9081,10 +9141,12 @@ itemType: ItemType.TRINKET,
 trinketType?: TrinketType
 ];
 
+/** @noSelfInFile */
 declare type PreNewLevelRegisterParameters = [
 callback: (player: EntityPlayer) => void
 ];
 
+/** @noSelfInFile */
 /**
  * Helper function to prevent an entity from spawning any other entities. Meant to be used on NPCs
  * like Squirts. This behavior will only last for the current room.
@@ -9712,6 +9774,7 @@ export declare function removeDoors(...doors: GridEntityDoor[]): void;
  */
 export declare function removeEntities<T extends AnyEntity>(entities: T[], cap?: int): T[];
 
+/** @noSelfInFile */
 /**
  * Removes the fade-in that occurs at the beginning of a run. If this behavior is desired, call this
  * function once at the beginning of your mod.
@@ -9874,6 +9937,7 @@ export declare function restoreFadeIn(): void;
 
 export declare function rngEquals(rng1: RNG, rng2: RNG): boolean;
 
+/** @noSelfInFile */
 /** This is used in the various rock alt type helper functions. */
 export declare enum RockAltType {
     URN = 0,
@@ -9947,6 +10011,7 @@ export declare function roomUpdateSafe(): void;
  */
 export declare function round(num: float, numDecimalPlaces?: number): float;
 
+/** @noSelfInFile */
 /**
  * Run the suite of tests that prove that the "deepCopy" helper function works properly.
  *
@@ -9954,6 +10019,7 @@ export declare function round(num: float, numDecimalPlaces?: number): float;
  */
 export declare function runDeepCopyTests(): void;
 
+/** @noSelfInFile */
 /**
  * Supply a function to run N game frames from now in the `POST_UPDATE` callback.
  *
@@ -9978,6 +10044,7 @@ export declare function runInNGameFrames(func: () => void, gameFrames: int): voi
  */
 export declare function runInNRenderFrames(func: () => void, renderFrames: int): void;
 
+/** @noSelfInFile */
 /**
  * Run the suite of tests that prove that the "merge" function works properly. (This function is not
  * exported but is used internally in the save data manager.)
@@ -10026,6 +10093,7 @@ export declare function runNextGameFrame(func: () => void): void;
  */
 export declare function runNextRenderFrame(func: () => void): void;
 
+/** @noSelfInFile */
 /**
  * This is the format of the object that you give to the save data manager. It will contains all of
  * the variables for the particular mod feature.
@@ -10054,6 +10122,7 @@ export declare interface SaveData<Persistent = unknown, Run = unknown, Level = u
     room?: Record<string, unknown>;
 }
 
+/** @noSelfInFile */
 /**
  * These are the types of keys that you can put on the local variables that you feed to the save
  * data manager.
@@ -10247,6 +10316,7 @@ declare type SerializableReadonlySet<T> = ReadonlySet<SerializableInsideArrayOrM
 
 declare type SerializableSet<T> = Set<SerializableInsideArrayOrMap<T>>;
 
+/** @noSelfInFile */
 /** This is used with the `deepCopy` and `merge` functions. */
 export declare enum SerializationType {
     NONE = 0,
@@ -10266,14 +10336,17 @@ export declare function serializeBitSet128(bitSet128: BitSet128): SerializedBitS
  */
 export declare function serializeColor(color: Color): SerializedColor;
 
+/** @noSelfInFile */
 export declare type SerializedBitSet128 = LuaMap<string, unknown> & {
     readonly __serializedBitSet128Brand: symbol;
 };
 
+/** @noSelfInFile */
 export declare type SerializedColor = LuaMap<string, unknown> & {
     readonly __serializedColorBrand: symbol;
 };
 
+/** @noSelfInFile */
 /**
  * This is a type representing an Isaac API class like `Color` or `RNG` that has been written to the
  * "save#.dat" file. It is used by the save data manager when reading and writing to that file.
@@ -10284,10 +10357,12 @@ export declare type SerializedIsaacAPIClass = LuaMap<string, unknown> & {
     readonly __serializedIsaacAPIClassBrand: symbol;
 };
 
+/** @noSelfInFile */
 export declare type SerializedKColor = LuaMap<string, unknown> & {
     readonly __serializedKColorBrand: symbol;
 };
 
+/** @noSelfInFile */
 export declare type SerializedRNG = LuaMap<string, unknown> & {
     readonly __serializedRNGBrand: symbol;
 };
@@ -10642,6 +10717,7 @@ export declare function setPickupDisplay(textCallback: (pickup: EntityPickup) =>
  */
 export declare function setPitDisplay(textCallback: (pit: GridEntityPit) => string): void;
 
+/** @noSelfInFile */
 /**
  * After using the "playerDisplay" console command, text will be drawn on each player for debugging
  * purposes. Use this function to specify a callback function that will returns the string that
@@ -10848,6 +10924,7 @@ export declare function shuffleArrayInPlace<T>(array: T[], seedOrRNG?: Seed | RN
  */
 export declare function sign(n: number): int;
 
+/** @noSelfInFile */
 /** This is used in the `POST_SLOT_DESTROYED` custom callback. */
 export declare enum SlotDestructionType {
     NORMAL = 0,
@@ -11399,6 +11476,7 @@ export declare function spriteEquals(sprite1: Sprite, sprite2: Sprite, layerID:
  */
 export declare function stageTypeToLetter(stageType: StageType): string;
 
+/** @noSelfInFile */
 /**
  * Helper function to start a Challenge Room or the Boss Rush.
  *
@@ -11407,6 +11485,7 @@ export declare function stageTypeToLetter(stageType: StageType): string;
  */
 export declare function startAmbush(): void;
 
+/** @noSelfInFile */
 /** This represents the kinds of stats that a player can have. */
 export declare enum StatType {
     /** Corresponds to `CacheFlag.DAMAGE` (1 << 0) and `EntityPlayer.Damage`. */
@@ -11457,6 +11536,7 @@ export declare interface StatTypeType {
     [StatType.SIZE]: Vector;
 }
 
+/** @noSelfInFile */
 export declare function stopAllSoundEffects(): void;
 
 /** Helper function to sum every value in an array together. */
@@ -11734,6 +11814,7 @@ export declare interface TrinketSituation {
     numSmeltedTrinkets: int;
 }
 
+/** @noSelfInFile */
 /**
  * This is a type representing a user-created class from TypeScript code.
  *

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,sCAAsC,CAAC;AACrD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,yCAAyC,CAAC;AACxD,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oCAAoC,CAAC;AACnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,sCAAsC,CAAC;AACrD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,yCAAyC,CAAC;AACxD,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oCAAoC,CAAC;AACnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,mBAAmB,CAAC"}