isaacscript-common 7.18.0 → 8.1.0

package/dist/index.d.ts

@@ -792,6 +792,7 @@ export declare function closeDoorFast(door: GridEntityDoor): void;
 /** This is the initial value of the `EntityPickup.Wait` field after a collectible is spawned. */
 export declare const COLLECTIBLE_INITIAL_WAIT = 20;
 
+/** Helper function to check in the item config if a given collectible has a given cache flag. */
 export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
 
 export declare function collectibleHasTag(collectibleType: CollectibleType, tag: ItemConfigTag): boolean;
@@ -2141,33 +2142,6 @@ export declare const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType;
 /** Equal to `PillColor.HORSE_BLUE_BLUE`. */
 export declare const FIRST_HORSE_PILL_COLOR = PillColor.HORSE_BLUE_BLUE;
 
-/** If there are no modded cards, this constant will represent a card that does not exist. */
-export declare const FIRST_MODDED_CARD: Card;
-
-/**
- * If there are no modded characters, this constant will represent a character that does not exist.
- * (There is no way to determine the amount of modded characters at run-time, since there is no
- * exposed player config.)
- */
-export declare const FIRST_MODDED_CHARACTER: PlayerType;
-
-/**
- * If there are no modded collectibles, this constant will represent a collectible type that does
- * not exist.
- */
-export declare const FIRST_MODDED_COLLECTIBLE_TYPE: CollectibleType;
-
-/**
- * If there are no modded pill effects, this constant will represent a pill effect that does not
- * exist.
- */
-export declare const FIRST_MODDED_PILL_EFFECT: PillEffect;
-
-/**
- * If there are no modded trinkets, this constant will represent a trinket type that does not exist.
- */
-export declare const FIRST_MODDED_TRINKET_TYPE: TrinketType;
-
 /** Equal to `PillColor.BLUE_BLUE`. */
 export declare const FIRST_PILL_COLOR = PillColor.BLUE_BLUE;
 
@@ -2327,7 +2301,12 @@ export declare function getAliveNPCs(entityType?: EntityType, variant?: number,
  */
 export declare function getAllBossesSet(): Set<string>;
 
-/** Helper function to get an array with every valid card sub-type. This includes modded cards. */
+/**
+ * Helper function to get an array with every valid card sub-type. This includes modded cards.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all cards will necessarily be present when a mod first loads (due to mod load order).
+ */
 export declare function getAllCards(): Card[];
 
 /**
@@ -2350,6 +2329,9 @@ export declare function getAllPillColors(): PillColor[];
 
 /**
  * Helper function to get an array with every valid pill effect. This includes modded pill effects.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all pill effects will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getAllPillEffects(): PillEffect[];
 
@@ -2599,6 +2581,9 @@ export declare function getCoinValue(coinSubType: CoinSubType): int;
  *
  * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
  * then use the `getCollectibleSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getCollectibleArray(): readonly CollectibleType[];
 
@@ -2741,12 +2726,18 @@ export declare function getCollectibles(collectibleType?: CollectibleType): Enti
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
  * then use the `getCollectibleArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getCollectibleSet(): ReadonlySet<CollectibleType>;
 
 /**
  * Returns a set containing every collectible type with the given cache flag, including modded
  * collectibles.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getCollectiblesForCacheFlag(cacheFlag: CacheFlag): Set<CollectibleType>;
 
@@ -2850,14 +2841,6 @@ export declare function getDebugPrependString(msg: string, numParentFunctions?:
  */
 export declare function getDefaultGlobals(): ReadonlySet<string>;
 
-/**
- * Returns the starting stat that Isaac (the default character) starts with. For example, if you
- * pass this function `CacheFlag.DAMAGE`, it will return 3.5.
- *
- * Note that the default fire delay is represented in the tear stat, not the `MaxFireDelay` value.
- */
-export declare function getDefaultPlayerStat(cacheFlag: CacheFlag): number | undefined;
-
 export declare function getDevilRoomDoor(): GridEntityDoor | undefined;
 
 /**
@@ -3129,6 +3112,38 @@ export declare function getFireDelay(tearsStat: float): float;
 
 export declare function getFirstCardOrPill(player: EntityPlayer): PocketItemDescription | undefined;
 
+/**
+ * Returns the first modded card sub-type, or undefined if there are no modded cards.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all cards will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getFirstModdedCard(): Card | undefined;
+
+/**
+ * Returns the first modded collectible type, or undefined if there are no modded collectibles.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getFirstModdedCollectibleType(): CollectibleType | undefined;
+
+/**
+ * Returns the first modded pill effect, or undefined if there are no modded pill effects.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all pill effects will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getFirstModdedPillEffect(): PillEffect | undefined;
+
+/**
+ * Returns the first modded trinket type, or undefined if there are no modded trinkets.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getFirstModdedTrinketType(): TrinketType | undefined;
+
 /**
  * Helper function to get the key associated with a particular flag.
  *
@@ -3376,6 +3391,28 @@ export declare function getLanguageName(): string;
  */
 export declare function getLasers(laserVariant?: LaserVariant, subType?: number): EntityLaser[];
 
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * This is equal to the number of cards, since all card sub-types are contiguous (unlike
+ * collectibles).
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all cards will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getLastCard(): Card;
+
+/**
+ * Will change depending on how many modded collectibles there are.
+ *
+ * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles, like
+ * 666. We subtract one to account for `CollectibleType.NULL`.)
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getLastCollectibleType(): CollectibleType;
+
 /**
  * Helper function to return the last element of an array.
  *
@@ -3404,6 +3441,28 @@ export declare function getLastEnumValue<T>(transpiledEnum: T): T[keyof T];
  */
 export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: string): int;
 
+/**
+ * Will change depending on how many modded pill effects there are.
+ *
+ * This is equal to the number of pill effects, since all pill effects are contiguous (unlike
+ * collectibles).
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all pill effects will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getLastPillEffect(): PillEffect;
+
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * This is equal to the number of trinket types, since all trinket types are contiguous (unlike
+ * collectibles).
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getLastTrinketType(): TrinketType;
+
 /**
  * Helper function to get information about the most recent room that is stored in the room history
  * array.
@@ -3445,6 +3504,9 @@ export declare function getMatchingGridEntities(gridEntityType: GridEntityType,
  * Helper function to get an array with every modded card sub-type.
  *
  * Returns an empty array if there are no modded cards.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all cards will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedCards(): Card[];
 
@@ -3453,6 +3515,9 @@ export declare function getModdedCards(): Card[];
  *
  * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
  * then use the `getModdedCollectibleSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedCollectibleArray(): readonly CollectibleType[];
 
@@ -3461,6 +3526,9 @@ export declare function getModdedCollectibleArray(): readonly CollectibleType[];
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
  * then use the `getModdedCollectibleArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
 
@@ -3475,6 +3543,9 @@ export declare function getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
  * (This function is named differently from the `getVanillaCollectibleTypeRange` function because
  * all modded collectible types are contiguous. Thus, each value represents a real
  * `CollectibleType`.)
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedCollectibleTypes(): CollectibleType[];
 
@@ -3482,6 +3553,9 @@ export declare function getModdedCollectibleTypes(): CollectibleType[];
  * Helper function to get an array with every modded pill effect.
  *
  * Returns an empty array if there are no modded pill effects.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all pill effects will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedPillEffects(): PillEffect[];
 
@@ -3490,6 +3564,9 @@ export declare function getModdedPillEffects(): PillEffect[];
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getTrinketSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedTrinketArray(): readonly TrinketType[];
 
@@ -3498,6 +3575,9 @@ export declare function getModdedTrinketArray(): readonly TrinketType[];
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getTrinketArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedTrinketSet(): ReadonlySet<TrinketType>;
 
@@ -3505,6 +3585,9 @@ export declare function getModdedTrinketSet(): ReadonlySet<TrinketType>;
  * Helper function to get an array that represents every modded trinket type.
  *
  * Returns an empty array if there are no modded trinket types.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getModdedTrinketTypes(): TrinketType[];
 
@@ -3613,12 +3696,76 @@ export declare function getNumbersFromTable(luaMap: LuaMap<string, unknown>, obj
 /** Helper function to get the number of bits in a binary representation of a number. */
 export declare function getNumBitsOfN(n: int): int;
 
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all cards will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumCards(): int;
+
+/**
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumCollectibleTypes(): int;
+
+/**
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumModdedCards(): int;
+
+/**
+ * Unlike vanilla collectible types, modded collectible types are always contiguous.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumModdedCollectibleTypes(): int;
+
+/**
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all pill effects will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumModdedPillEffects(): int;
+
+/**
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumModdedTrinketTypes(): int;
+
+/**
+ * Will change depending on how many modded pill effects there are.
+ *
+ * Equal to `itemConfig.GetPillEffects().Size`. (We do not have to subtract one, because the first
+ * pill effect has an ID of 0 and there is no `PillEffect.NULL`.)
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all pill effects will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumPillEffects(): int;
+
 /**
  * Helper function to get the number of rooms that are currently on the floor layout. This does not
  * include off-grid rooms, like the Devil Room.
  */
 export declare function getNumRooms(): int;
 
+/**
+ * Will change depending on how many modded cards there are.
+ *
+ * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
+ * `TrinketType.NULL`.)
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
+ */
+export declare function getNumTrinketTypes(): int;
+
 /**
  * Returns the slot number corresponding to where a trinket can be safely inserted.
  *
@@ -3784,6 +3931,9 @@ export declare function getPlayerCollectibleMap(player: EntityPlayer): Map<Colle
  *   CollectibleType.DEAD_DOVE,
  * ]
  * ```
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getPlayerCollectiblesForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
 
@@ -3974,7 +4124,10 @@ export declare function getPlayerTransformations(player: EntityPlayer): Set<Play
 
 /**
  * Returns a map containing every trinket type that the player has that matches the provided
- * CacheFlag. The values of the map correspond to the multiplier for that trinket.
+ * `CacheFlag`. The values of the map correspond to the multiplier for that trinket.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getPlayerTrinketsForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
 
@@ -4844,6 +4997,9 @@ export declare function getTraversalDescription(key: unknown, traversalDescripti
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getModdedTrinketSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getTrinketArray(): readonly TrinketType[];
 
@@ -4879,15 +5035,26 @@ export declare function getTrinkets(trinketType?: TrinketType): EntityPickupTrin
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getModdedTrinketArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getTrinketSet(): ReadonlySet<TrinketType>;
 
 /**
  * Returns a set containing every trinket type with the given cache flag, including modded trinkets.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType>;
 
-/** Helper function to get an array that contains every trinket type. */
+/**
+ * Helper function to get an array that contains every trinket type.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
+ */
 export declare function getTrinketTypes(): TrinketType[];
 
 /**
@@ -4913,6 +5080,9 @@ export declare function getVanillaCards(): Card[];
  *
  * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
  * then use the `getVanillaCollectibleSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getVanillaCollectibleArray(): readonly CollectibleType[];
 
@@ -4921,6 +5091,9 @@ export declare function getVanillaCollectibleArray(): readonly CollectibleType[]
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
  * then use the `getVanillaCollectibleArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all collectibles will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getVanillaCollectibleSet(): ReadonlySet<CollectibleType>;
 
@@ -4942,6 +5115,9 @@ export declare function getVanillaPillEffects(): PillEffect[];
  *
  * Use this if you need to iterate over the trinkets in order. If you need to do O(1) lookups, then
  * use the `getVanillaTrinketSet` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getVanillaTrinketArray(): readonly TrinketType[];
 
@@ -4950,6 +5126,9 @@ export declare function getVanillaTrinketArray(): readonly TrinketType[];
  *
  * Use this if you need to do O(1) lookups. If you need to iterate over the trinkets in order, then
  * use the `getVanillaTrinketArray` helper function instead.
+ *
+ * This function can only be called if at least one callback has been executed. This is because not
+ * all trinkets will necessarily be present when a mod first loads (due to mod load order).
  */
 export declare function getVanillaTrinketSet(): ReadonlySet<TrinketType>;
 
@@ -5190,15 +5369,7 @@ export declare function inDoubleTrouble(): boolean;
 
 export declare function inGenesisRoom(): boolean;
 
-/**
- * Initializes an array with all elements containing the specified default value.
- *
- * For example:
- *
- * ```ts
- * const playerTransformations = initArray(false, PlayerForm.NUM_PLAYER_FORMS - 1);
- * ```
- */
+/** Initializes an array with all elements containing the specified default value. */
 export declare function initArray<T>(defaultValue: T, size: int): T[];
 
 /**
@@ -6189,21 +6360,6 @@ export declare function kColorEquals(kColor1: KColor, kColor2: KColor): boolean;
  */
 export declare function keyboardToString(keyboard: Keyboard, uppercase: boolean): string | undefined;
 
-/**
- * Will change depending on how many modded cards there are.
- *
- * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
- */
-export declare const LAST_CARD: Card;
-
-/**
- * Will change depending on how many modded collectibles there are.
- *
- * Equal to `itemConfig.GetCollectibles().Size - 1`. (`Size` includes invalid collectibles, like
- * 666. We subtract one to account for `CollectibleType.NULL`.)
- */
-export declare const LAST_COLLECTIBLE_TYPE: CollectibleType;
-
 /**
  * Equal to `PillColor.HORSE_WHITE_YELLOW`.
  *
@@ -6220,25 +6376,12 @@ export declare const LAST_HORSE_PILL_COLOR = PillColor.HORSE_WHITE_YELLOW;
  */
 export declare const LAST_NORMAL_PILL_COLOR = PillColor.WHITE_YELLOW;
 
-/**
- * Will change depending on how many modded pill effects there are.
- *
- * Equal to `itemConfig.GetPillEffects().Size - 1`. (We subtract one to account for
- * `PillEffect.NULL`.)
- */
-export declare const LAST_PILL_EFFECT: PillEffect;
-
 export declare const LAST_ROOM_TYPE: RoomType;
 
 export declare const LAST_STAGE: LevelStage;
 
-/**
- * Will change depending on how many modded cards there are.
- *
- * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
- * `TrinketType.NULL`.)
- */
-export declare const LAST_TRINKET_TYPE: TrinketType;
+/** Calculated from the `Card` enum. */
+export declare const LAST_VANILLA_CARD: Card;
 
 /** Calculated from the `PlayerType` enum. */
 export declare const LAST_VANILLA_CHARACTER: PlayerType;
@@ -6492,9 +6635,6 @@ export declare const MAX_SPEED_STAT = 2;
 /** Corresponds to the maximum value for `EntityPlayer.SamsonBerserkCharge`. */
 export declare const MAX_TAINTED_SAMSON_BERSERK_CHARGE = 100000;
 
-/** Calculated from the `Card` enum. */
-export declare const MAX_VANILLA_CARD: Card;
-
 /** If you set `EntityPlayer.ShotSpeed` lower than this value, it will have no effect. */
 export declare const MIN_PLAYER_SHOT_SPEED_STAT = 0.6;
 
@@ -6825,6 +6965,9 @@ export declare enum ModCallbackCustom {
      * the broken state for the respective grid entity type. (For example, this will fire for a
      * `GridEntityType.ROCK` (2) when its state changes to `RockState.BROKEN` (2).)
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_BROKEN` callback instead.
+     *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
      *
@@ -6838,6 +6981,9 @@ export declare enum ModCallbackCustom {
      * this, the callback will not continue to fire. It will only fire again once the entity moves out
      * of range and then moves back into range.)
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_COLLISION` callback instead.
+     *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
      *
@@ -6965,6 +7111,9 @@ export declare enum ModCallbackCustom {
      * - in the `POST_UPDATE` callback (if the entity appeared mid-way through the room, like when the
      *   trapdoor appears after defeating It Lives!)
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
+     * callback instead.
+     *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
      *
@@ -6981,6 +7130,9 @@ export declare enum ModCallbackCustom {
      *
      * This will fire when a Polty/Kineti picks up a grid entity.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_REMOVE` callback instead.
+     *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
      *
@@ -7000,6 +7152,9 @@ export declare enum ModCallbackCustom {
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
+     *
      * ```ts
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
@@ -7012,6 +7167,9 @@ export declare enum ModCallbackCustom {
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_STATE_CHANGED` callback instead.
+     *
      * ```ts
      * function postGridEntityStateChanged(
      *   gridEntity: GridEntity,
@@ -7029,6 +7187,9 @@ export declare enum ModCallbackCustom {
      * - When registering the callback, takes an optional third argument that will make the callback
      *   only fire if it matches the variant provided.
      *
+     * For grid entities created with `spawnCustomGridEntity`, use the
+     * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
+     *
      * ```ts
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
@@ -7988,64 +8149,30 @@ export declare function newTSTLClass(oldClass: TSTLClass): TSTLClass;
  */
 export declare function nextSeed(seed: Seed): Seed;
 
-/**
- * Will change depending on how many modded cards there are.
- *
- * Equal to `itemConfig.GetCards().Size - 1`. (We subtract one to account for `Card.NULL`.)
- */
-export declare const NUM_CARDS: number;
-
-export declare const NUM_COLLECTIBLE_TYPES: number;
-
 export declare const NUM_DIMENSIONS: number;
 
-export declare const NUM_MODDED_CARDS: number;
-
-/** Unlike vanilla collectible types, modded collectible types are always contiguous. */
-export declare const NUM_MODDED_COLLECTIBLE_TYPES: number;
-
-export declare const NUM_MODDED_PILL_EFFECTS: number;
-
-export declare const NUM_MODDED_TRINKET_TYPES: number;
-
 export declare const NUM_NORMAL_PILL_COLORS: number;
 
-/**
- * Will change depending on how many modded pill effects there are.
- *
- * Equal to `itemConfig.GetPillEffects().Size - 1`. (We subtract one to account for
- * `PillEffect.NULL`.)
- */
-export declare const NUM_PILL_EFFECTS: number;
-
 /**
  * The pill pool for each run is comprised of one effect for each unique pill color (minus gold and
  * horse pills.)
  */
 export declare const NUM_PILLS_IN_POOL: number;
 
-/**
- * Will change depending on how many modded cards there are.
- *
- * Equal to `itemConfig.GetTrinkets().Size - 1`. (We subtract one to account for
- * `TrinketType.NULL`.)
- */
-export declare const NUM_TRINKET_TYPES: number;
-
 /** Calculated from the `Card` enum. `Card.NULL` is not included. */
 export declare const NUM_VANILLA_CARDS: number;
 
-/** Calculated from the `CollectibleType` enum. `CollectibleType.NULL` is not included. */
+/** Calculated from the `CollectibleType` enum. (`CollectibleType.NULL` is not included.) */
 export declare const NUM_VANILLA_COLLECTIBLE_TYPES: number;
 
 /**
  * Calculated from the `PillEffect` enum.
  *
- * (There is no `PillEffect.NULL` in the custom enum, so we don't have to subtract one here.)
+ * (There is no `PillEffect.NULL` in the custom enum, so we do not have to subtract one here.)
  */
 export declare const NUM_VANILLA_PILL_EFFECTS: number;
 
-/** Calculated from the `TrinketType` enum. `TrinketType.NULL` is not included. */
+/** Calculated from the `TrinketType` enum. (`TrinketType.NULL` is not included.) */
 export declare const NUM_VANILLA_TRINKET_TYPES: number;
 
 export declare function onAscent(): boolean;
@@ -8841,6 +8968,12 @@ export declare function registerHotkey(keyboardOrFunc: Keyboard | (() => Keyboar
  */
 export declare function reloadRoom(): void;
 
+/**
+ * Helper function to remove all of the active items from a player. This includes the Schoolbag item
+ * and any pocket actives.
+ */
+export declare function removeAllActiveItems(player: EntityPlayer): void;
+
 /**
  * Helper function to remove all of the batteries in the room.
  *
@@ -9088,6 +9221,14 @@ export declare function removeAllPits(pitVariant?: PitVariant, updateRoom?: bool
 
 export declare function removeAllPlayerHealth(player: EntityPlayer): void;
 
+/**
+ * Helper function to remove all of the held trinkets from a player.
+ *
+ * This will not remove any smelted trinkets, unless the player happens to be holding a trinket that
+ * they also have smelted. (In that case, both the held and the smelted trinket will be removed.)
+ */
+export declare function removeAllPlayerTrinkets(player: EntityPlayer): void;
+
 /**
  * Helper function to remove all of the `GridEntityPoop` in the room.
  *
@@ -11260,6 +11401,7 @@ export declare function trimPrefix(string: string, prefix: string): string;
 /** Helper function to trim a suffix from a string, if it exists. Returns the trimmed string. */
 export declare function trimSuffix(string: string, prefix: string): string;
 
+/** Helper function to check in the item config if a given trinket has a given cache flag. */
 export declare function trinketHasCacheFlag(trinketType: TrinketType, cacheFlag: CacheFlag): boolean;
 
 /** This is used by the `temporarilyRemoveTrinkets` and related helper functions. */