isaacscript-common 76.2.0 → 76.3.0

package/src/classes/features/other/ItemPoolDetection.ts

@@ -48,6 +48,8 @@ export class ItemPoolDetection extends Feature {
    * expensive, so only use it in situations where the lag is acceptable.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getCollectiblesInItemPool(
@@ -70,6 +72,8 @@ export class ItemPoolDetection extends Feature {
    * blacklist every collectible except for the one provided.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public isCollectibleInItemPool(
@@ -153,6 +157,8 @@ export class ItemPoolDetection extends Feature {
    *   collectibles from item pools).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ITEM_POOL_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public isCollectibleUnlocked(

package/src/classes/features/other/ModdedElementDetection.ts

@@ -75,6 +75,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getFirstModdedCollectibleType(): CollectibleType | undefined {
@@ -107,6 +109,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getLastCollectibleType(): CollectibleType {
@@ -125,6 +129,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumCollectibleTypes(): int {
@@ -143,6 +149,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumModdedCollectibleTypes(): int {
@@ -164,6 +172,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getFirstModdedTrinketType(): TrinketType | undefined {
@@ -190,6 +200,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getLastTrinketType(): TrinketType {
@@ -207,6 +219,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumTrinketTypes(): int {
@@ -224,6 +238,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumModdedTrinketTypes(): int {
@@ -245,6 +261,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getFirstModdedCardType(): CardType | undefined {
@@ -269,6 +287,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getLastCardType(): CardType {
@@ -288,6 +308,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumCardTypes(): int {
@@ -301,6 +323,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumModdedCardTypes(): int {
@@ -323,6 +347,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getFirstModdedPillEffect(): PillEffect | undefined {
@@ -352,6 +378,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getLastPillEffect(): PillEffect {
@@ -373,6 +401,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumPillEffects(): int {
@@ -387,6 +417,8 @@ export class ModdedElementDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.MODDED_ELEMENT_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public getNumModdedPillEffects(): int {

package/src/classes/features/other/ModdedElementSets.ts

@@ -496,6 +496,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCollectibleTypes(): readonly CollectibleType[] {
@@ -515,6 +517,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCollectibleTypeSet(): ReadonlySet<CollectibleType> {
@@ -533,6 +537,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedCollectibleTypes(): readonly CollectibleType[] {
@@ -551,6 +557,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedCollectibleTypesSet(): ReadonlySet<CollectibleType> {
@@ -569,6 +577,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPlayerCollectibleMap(
@@ -624,6 +634,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getTrinketTypes(): readonly TrinketType[] {
@@ -642,6 +654,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getTrinketTypesSet(): ReadonlySet<TrinketType> {
@@ -660,6 +674,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedTrinketTypes(): readonly TrinketType[] {
@@ -678,6 +694,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedTrinketTypesSet(): ReadonlySet<TrinketType> {
@@ -699,6 +717,8 @@ export class ModdedElementSets extends Feature {
    * not all card types will necessarily be present when a mod first loads (due to mod load order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCardTypes(): readonly CardType[] {
@@ -716,6 +736,8 @@ export class ModdedElementSets extends Feature {
    * not all card types will necessarily be present when a mod first loads (due to mod load order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCardTypesSet(): ReadonlySet<CardType> {
@@ -733,6 +755,8 @@ export class ModdedElementSets extends Feature {
    * not all card types will necessarily be present when a mod first loads (due to mod load order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedCardTypes(): readonly CardType[] {
@@ -750,6 +774,8 @@ export class ModdedElementSets extends Feature {
    * not all card types will necessarily be present when a mod first loads (due to mod load order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedCardTypesSet(): ReadonlySet<CardType> {
@@ -772,6 +798,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPillEffects(): readonly PillEffect[] {
@@ -790,6 +818,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPillEffectsSet(): ReadonlySet<PillEffect> {
@@ -808,6 +838,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedPillEffects(): readonly PillEffect[] {
@@ -826,6 +858,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getModdedPillEffectsSet(): ReadonlySet<PillEffect> {
@@ -846,6 +880,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCollectibleTypesWithCacheFlag(
@@ -870,6 +906,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getTrinketsTypesWithCacheFlag(
@@ -908,6 +946,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPlayerCollectiblesWithCacheFlag(
@@ -940,6 +980,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPlayerTrinketsWithCacheFlag(
@@ -980,6 +1022,7 @@ export class ModdedElementSets extends Feature {
    *
    * @param includeConditionalItems Whether collectibles that only grant flight conditionally should
    *                                be included in the set (like Empty Vessel).
+   * @public
    */
   @Exported
   public getFlyingCollectibleTypes(
@@ -1005,6 +1048,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getFlyingTrinketTypes(): ReadonlySet<TrinketType> {
@@ -1031,6 +1076,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCollectibleTypesWithTag(
@@ -1055,6 +1102,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPlayerCollectiblesWithTag(
@@ -1091,6 +1140,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCollectibleTypesForTransformation(
@@ -1114,6 +1165,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPlayerCollectiblesForTransformation(
@@ -1148,6 +1201,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getEdenActiveCollectibleTypes(): ReadonlySet<CollectibleType> {
@@ -1166,6 +1221,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getEdenPassiveCollectibleTypes(): ReadonlySet<CollectibleType> {
@@ -1189,6 +1246,7 @@ export class ModdedElementSets extends Feature {
    *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
    *                  to a random seed.
    * @param exceptions Optional. An array of runes to not select.
+   * @public
    */
   @Exported
   public getRandomEdenActiveCollectibleType(
@@ -1221,6 +1279,7 @@ export class ModdedElementSets extends Feature {
    *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
    *                  to a random seed.
    * @param exceptions Optional. An array of runes to not select.
+   * @public
    */
   @Exported
   public getRandomEdenPassiveCollectibleType(
@@ -1248,6 +1307,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCollectibleTypesOfQuality(
@@ -1272,6 +1333,8 @@ export class ModdedElementSets extends Feature {
    * order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getPlayerCollectiblesOfQuality(
@@ -1309,6 +1372,8 @@ export class ModdedElementSets extends Feature {
    * not all card types will necessarily be present when a mod first loads (due to mod load order).
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.MODDED_ELEMENT_SETS`.
+   *
+   * @public
    */
   @Exported
   public getCardTypesOfType(
@@ -1350,6 +1415,7 @@ export class ModdedElementSets extends Feature {
    *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
    *                  to a random seed.
    * @param exceptions Optional. An array of cards to not select.
+   * @public
    */
   @Exported
   public getRandomCardTypeOfType(
@@ -1380,6 +1446,7 @@ export class ModdedElementSets extends Feature {
    *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
    *                  to a random seed.
    * @param exceptions Optional. An array of cards to not select.
+   * @public
    */
   @Exported
   public getRandomCard(
@@ -1406,6 +1473,7 @@ export class ModdedElementSets extends Feature {
    *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
    *                  to a random seed.
    * @param exceptions Optional. An array of runes to not select.
+   * @public
    */
   @Exported
   public getRandomRune(

package/src/classes/features/other/NoSirenSteal.ts

@@ -87,6 +87,7 @@ export class NoSirenSteal extends Feature {
    * @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.
+   * @public
    */
   @Exported
   public setFamiliarNoSirenSteal(

package/src/classes/features/other/Pause.ts

@@ -121,6 +121,12 @@ export class Pause extends Feature {
     return 1;
   };
 
+  /**
+   * Helper function to check if the pause feature from `isaacscript-common` is currently
+   * pseudo-pausing the game.
+   *
+   * @public
+   */
   @Exported
   public isPaused(): boolean {
     return v.run.isPseudoPaused;
@@ -136,6 +142,8 @@ export class Pause extends Feature {
    *   `ButtonAction.CONSOLE`)
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
+   *
+   * @public
    */
   @Exported
   public pause(): void {
@@ -199,6 +207,8 @@ export class Pause extends Feature {
    * Helper function to put things back to normal after the `pause` function was used.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.PAUSE`.
+   *
+   * @public
    */
   @Exported
   public unpause(): void {

package/src/classes/features/other/PersistentEntities.ts

@@ -160,6 +160,7 @@ export class PersistentEntities extends Feature {
    * @param removeEntity Optional. True by default. Set to false if you want to stop an entity from
    *                     being persistent but you don't want to actually remove the
    *                     currently-spawned entity from the room.
+   * @public
    */
   @Exported
   public removePersistentEntity(
@@ -199,6 +200,7 @@ export class PersistentEntities extends Feature {
    *
    * @returns An object containing the entity and the persistent entity index. You can use the index
    *          with the `removePersistentEntity` function.
+   * @public
    */
   @Exported
   public spawnPersistentEntity(

package/src/classes/features/other/PlayerCollectibleTracking.ts

@@ -86,6 +86,7 @@ export class PlayerCollectibleTracking extends Feature {
    * @param player The player to get the collectible types for.
    * @param includeActiveCollectibles Optional. If true, will include all active collectibles.
    *                                Default is true.
+   * @public
    */
   @Exported
   public getPlayerCollectibleTypes(
@@ -115,6 +116,8 @@ export class PlayerCollectibleTracking extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.PLAYER_COLLECTIBLE_TRACKING`.
+   *
+   * @public
    */
   @Exported
   public getPlayerLastPassiveCollectibleType(

package/src/classes/features/other/PonyDetection.ts

@@ -66,6 +66,8 @@ export class PonyDetection extends Feature {
    * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public isPlayerUsingPony(player: EntityPlayer): boolean {
@@ -77,6 +79,8 @@ export class PonyDetection extends Feature {
    * Detecting this is difficult, as the temporary effect will disappear upon entering a new room.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.PONY_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public anyPlayerUsingPony(): boolean {

package/src/classes/features/other/PreventChildEntities.ts

@@ -47,6 +47,8 @@ export class PreventChildEntities extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.PREVENT_CHILD_ENTITIES`.
+   *
+   * @public
    */
   @Exported
   public preventChildEntities(entity: Entity): void {

package/src/classes/features/other/RoomClearFrame.ts

@@ -6,6 +6,7 @@ import { Feature } from "../../private/Feature";
 const v = {
   room: {
     roomClearGameFrame: undefined as int | undefined,
+    roomClearRenderFrame: undefined as int | undefined,
     roomClearRoomFrame: undefined as int | undefined,
   },
 };
@@ -32,8 +33,10 @@ export class RoomClearFrame extends Feature {
     const gameFrameCount = game.GetFrameCount();
     const room = game.GetRoom();
     const roomFrameCount = room.GetFrameCount();
+    const renderFrameCount = Isaac.GetFrameCount();
 
     v.room.roomClearGameFrame = gameFrameCount;
+    v.room.roomClearRenderFrame = renderFrameCount;
     v.room.roomClearRoomFrame = roomFrameCount;
   };
 
@@ -41,21 +44,44 @@ export class RoomClearFrame extends Feature {
    * 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.
    *
+   * Note that if the room is left, all room clear tracking for it will be discarded.
+   *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
+   *
+   * @public
    */
   @Exported
   public getRoomClearGameFrame(): int | undefined {
     return v.room.roomClearGameFrame;
   }
 
+  /**
+   * Helper function to get the render frame (i.e. `Isaac.GetFrameCount`) of the last time that this
+   * room was cleared. Returns undefined if the room has never been cleared.
+   *
+   * Note that if the room is left, all room clear tracking for it will be discarded.
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
+   *
+   * @public
+   */
+  @Exported
+  public getRoomClearRenderFrame(): int | undefined {
+    return v.room.roomClearRenderFrame;
+  }
+
   /**
    * Helper function to get the room frame (i.e. `Room.GetFrameCount`) of the last time that this
    * room was cleared. Returns undefined if the room has never been cleared.
    *
+   * Note that if the room is left, all room clear tracking for it will be discarded.
+   *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_CLEAR_FRAME`.
+   *
+   * @public
    */
   @Exported
   public getRoomClearRoomFrame(): int | undefined {
-    return v.room.roomClearGameFrame;
+    return v.room.roomClearRoomFrame;
   }
 }