isaacscript-common 76.2.0 → 76.3.0

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

@@ -72,6 +72,8 @@ export class RoomHistory extends Feature {
    * Helper function to manually delete the last room description from the internal array. This is
    * useful if a mod needs to send the player to a room temporarily and the room should not count as
    * the player having traveled to that room.
+   *
+   * @public
    */
   @Exported
   public deleteLastRoomDescription(): void {
@@ -83,6 +85,8 @@ export class RoomHistory extends Feature {
    * run. (Re-entering the same room will increment the number returned.)
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+   *
+   * @public
    */
   @Exported
   public getNumRoomsEntered(): int {
@@ -94,6 +98,8 @@ export class RoomHistory extends Feature {
    * this run.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+   *
+   * @public
    */
   @Exported
   public getRoomHistory(): ReadonlyArray<Readonly<RoomDescription>> {
@@ -107,6 +113,8 @@ export class RoomHistory extends Feature {
    * the run), the starting room will be returned.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+   *
+   * @public
    */
   @Exported
   public getPreviousRoomDescription(): Readonly<RoomDescription> {
@@ -135,13 +143,19 @@ export class RoomHistory extends Feature {
    * of the run.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+   *
+   * @public
    */
   @Exported
   public getLatestRoomDescription(): Readonly<RoomDescription> | undefined {
     return v.run.roomHistory.at(-1);
   }
 
-  /** Helper function to detect if the player is on the first room of the room. */
+  /**
+   * Helper function to detect if the player is on the first room of the room.
+   *
+   * @public
+   */
   @Exported
   public inFirstRoom(): boolean {
     return v.run.roomHistory.length === 1;
@@ -157,6 +171,8 @@ export class RoomHistory extends Feature {
    * entity is despawning.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.ROOM_HISTORY`.
+   *
+   * @public
    */
   @Exported
   public isLeavingRoom(): boolean {

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

@@ -100,9 +100,10 @@ export class RunInNFrames extends Feature {
    * the game inside of the `POST_NEW_ROOM`, `POST_NEW_LEVEL`, or `POST_GAME_STARTED` callbacks when
    * a run is first starting.
    *
-   * You can optionally specify a `PlayerType` to restart the game as that character.
-   *
    * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_IN_N_FRAMES`.
+   *
+   * @param character Optional. If specified, will restart the game as the specified character.
+   * @public
    */
   @Exported
   public restartNextRenderFrame(character?: PlayerType): void {
@@ -127,6 +128,7 @@ export class RunInNFrames extends Feature {
    * @param numGameFrames The amount of game frames to wait before running the function.
    * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
    *                            loaded in the interim. Default is false.
+   * @public
    */
   @Exported
   public runInNGameFrames(
@@ -163,6 +165,7 @@ export class RunInNFrames extends Feature {
    * @param numRenderFrames The amount of render frames to wait before running the function.
    * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
    *                            loaded in the interim. Default is false.
+   * @public
    */
   @Exported
   public runInNRenderFrames(
@@ -216,6 +219,7 @@ export class RunInNFrames extends Feature {
    * @param func The function to run.
    * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
    *                            loaded in the interim. Default is false.
+   * @public
    */
   @Exported
   public runNextGameFrame(func: () => void, cancelIfRoomChanges = false): void {
@@ -235,6 +239,7 @@ export class RunInNFrames extends Feature {
    * @param func The function to run.
    * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
    *                            loaded in the interim. Default is false.
+   * @public
    */
   @Exported
   public runNextRenderFrame(
@@ -263,6 +268,7 @@ export class RunInNFrames extends Feature {
    *                       interval.
    * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
    *                            loaded in the interim. Default is false.
+   * @public
    */
   @Exported
   public setIntervalGameFrames(
@@ -310,6 +316,7 @@ export class RunInNFrames extends Feature {
    *                       interval.
    * @param cancelIfRoomChanges Optional. Whether to cancel running the function if a new room is
    *                            loaded in the interim. Default is false.
+   * @public
    */
   @Exported
   public setIntervalRenderFrames(

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

@@ -46,6 +46,8 @@ export class RunNextRun extends Feature {
    * deferred functions manually using serializable data.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.RUN_NEXT_ROOM`.
+   *
+   * @public
    */
   @Exported
   public runNextRun(func: () => void): void {

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

@@ -314,6 +314,7 @@ export class SaveDataManager extends Feature {
    *                        specify `false` to this argument in order to completely disable saving
    *                        data. (Specifying `false` will allow you to use non-serializable objects
    *                        in your save data, such as `EntityPtr`.
+   * @public
    */
   // This is the overload for the standard case with serializable data.
   public saveDataManager<Persistent, Run, Level>(
@@ -414,6 +415,8 @@ export class SaveDataManager extends Feature {
    * result in lost state.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   *
+   * @public
    */
   @Exported
   public saveDataManagerLoad(): void {
@@ -426,6 +429,8 @@ export class SaveDataManager extends Feature {
    * all of its variables to disk immediately.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   *
+   * @public
    */
   @Exported
   public saveDataManagerSave(): void {
@@ -439,6 +444,8 @@ export class SaveDataManager extends Feature {
    * e.g. `l print(g.feature1.run.foo)`
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   *
+   * @public
    */
   @Exported
   public saveDataManagerSetGlobal(): void {
@@ -456,6 +463,8 @@ export class SaveDataManager extends Feature {
    * This function is variadic, which means you can pass as many classes as you want to register.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   *
+   * @public
    */
   @Exported
   public saveDataManagerRegisterClass(...tstlClasses: AnyClass[]): void {
@@ -476,6 +485,8 @@ export class SaveDataManager extends Feature {
    * "saveDataManager" method.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   *
+   * @public
    */
   @Exported
   public saveDataManagerRemove(key: string): void {
@@ -519,6 +530,8 @@ export class SaveDataManager extends Feature {
    * ```
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   *
+   * @public
    */
   @Exported
   public saveDataManagerReset(key: string, childObjectKey: SaveDataKey): void {
@@ -554,12 +567,20 @@ export class SaveDataManager extends Feature {
    * explicitly call the `saveDataManagerSave` function.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   *
+   * @public
    */
   @Exported
   public saveDataManagerInMenu(): boolean {
     return !this.inARun;
   }
 
+  /**
+   * Helper function to see all of the mod features that are using the save data manager. Useful for
+   * debugging if a certain mod feature is not getting its data saved correctly.
+   *
+   * @public
+   */
   @Exported
   public saveDataManagerLogSubscribers(): void {
     log("List of save data manager subscribers:");

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

@@ -103,6 +103,7 @@ export class SpawnRockAltRewards extends Feature {
    *                  `RNG.Next` method will be called. If `undefined` is provided, it will default
    *                  to a random seed.
    * @returns Whether this function spawned something.
+   * @public
    */
   @Exported
   public spawnRockAltReward(

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

@@ -55,6 +55,7 @@ export class StageHistory extends Feature {
    *
    * @param upwards Whether the player should go up to Cathedral in the case of being on Womb 2.
    *                Default is false.
+   * @public
    */
   @Exported
   public getNextStageTypeWithHistory(upwards = false): StageType {
@@ -295,6 +296,8 @@ export class StageHistory extends Feature {
    * Helper function to get all of the stages that a player has visited thus far on this run.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
+   *
+   * @public
    */
   @Exported
   public getStageHistory(): readonly StageHistoryEntry[] {

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

@@ -31,6 +31,8 @@ export class StartAmbush extends Feature {
    * and then removing the sack and the pickups that the sack dropped.
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.START_AMBUSH`.
+   *
+   * @public
    */
   @Exported
   public startAmbush(): void {

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

@@ -110,6 +110,8 @@ export class TaintedLazarusPlayers extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
+   *
+   * @public
    */
   @Exported
   public getTaintedLazarusSubPlayer(

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

@@ -48,6 +48,8 @@ export class UnlockAchievementsDetection extends Feature {
    *
    * In order to use this function, you must upgrade your mod with
    * `ISCFeature.UNLOCK_ACHIEVEMENTS_DETECTION`.
+   *
+   * @public
    */
   @Exported
   public canRunUnlockAchievements(): boolean {

package/src/classes/private/CustomCallback.ts

@@ -1,8 +1,6 @@
 import type { CallbackPriority } from "isaac-typescript-definitions";
 import type { ModCallbackCustom } from "../../enums/ModCallbackCustom";
-import { log } from "../../functions/log";
 import { sortObjectArrayByKey, stableSort } from "../../functions/sort";
-import { getTSTLClassName } from "../../functions/tstlClass";
 import type { AddCallbackParametersCustom } from "../../interfaces/private/AddCallbackParametersCustom";
 import type { AllButFirst } from "../../types/AllButFirst";
 import type { AnyFunction } from "../../types/AnyFunction";
@@ -105,17 +103,4 @@ export abstract class CustomCallback<
     fireArgs: FireArgs<T>,
     optionalArgs: OptionalArgs<T>,
   ) => boolean = () => true;
-
-  public logSubscriptions(): void {
-    const tstlClassName = getTSTLClassName(this);
-    log(`Logging subscriptions for custom callback: ${tstlClassName}`);
-
-    if (this.subscriptions.length === 0) {
-      log("- n/a (no subscriptions)");
-    } else {
-      for (const [i, subscription] of this.subscriptions.entries()) {
-        log(`- ${i + 1} - priority: ${subscription.priority}`);
-      }
-    }
-  }
 }