isaacscript-common 15.0.0 → 15.0.2

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

@@ -51,6 +51,8 @@ export class StageHistory extends Feature {
    * that the next stage type can be properly calculated on The Ascent (which makes it unlike the
    * `getNextStageType` function).
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
+   *
    * @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
    *                2. Default is false.
    */
@@ -159,6 +161,8 @@ export class StageHistory extends Feature {
    * This function accounts for the previous floors that a player has visited thus far on the run so
    * that the next stage can be properly calculated on The Ascent (which makes it unlike the
    * `getNextStage` function).
+   *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
    */
   @Exported
   public getNextStageWithHistory(): LevelStage {
@@ -287,7 +291,11 @@ export class StageHistory extends Feature {
     return asNumber(stage) - 1;
   }
 
-  /** Helper function to get all of the stages that a player has visited thus far on this run. */
+  /**
+   * 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`.
+   */
   @Exported
   public getStageHistory(): ReadonlyArray<
     [stage: LevelStage, stageType: StageType]
@@ -299,6 +307,8 @@ export class StageHistory extends Feature {
    * Helper function to check if a player has previous visited a particular stage (or stage + stage
    * type combination) on this run.
    *
+   * In order to use this function, you must upgrade your mod with `ISCFeature.STAGE_HISTORY`.
+   *
    * @param stage The stage to check for.
    * @param stageType Optional. If provided, will check for a specific stage and stage type
    *                  combination.

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

@@ -29,6 +29,8 @@ export class StartAmbush extends Feature {
    *
    * Specifically, this is performed by spawning a sack on top of the player, waiting a game frame,
    * 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`.
    */
   @Exported
   public startAmbush(): void {

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

@@ -106,6 +106,9 @@ export class TaintedLazarusPlayers extends Feature {
    * If you call the `EntityPlayer.Exists` method on the returned object, it will return false.
    * However, you can still call the other methods like you normally would (e.g.
    * `EntityPlayer.AddCollectible`).
+   *
+   * In order to use this function, you must upgrade your mod with
+   * `ISCFeature.CHARACTER_HEALTH_CONVERSION`.
    */
   @Exported
   public getTaintedLazarusSubPlayer(

package/src/types/ModUpgraded.ts

@@ -16,8 +16,8 @@ import { Writeable } from "./Writable";
  * By specifying one or more optional features, end-users will get a version of `ModUpgraded` that
  * has extra methods corresponding to the features that were specified.
  */
-export type ModUpgraded<T extends readonly ISCFeature[]> = ModUpgradedBase &
-  ISCFeaturesToKeys<T>;
+export type ModUpgraded<T extends readonly ISCFeature[] = []> =
+  ModUpgradedBase & ISCFeaturesToKeys<T>;
 
 /**
  * We want to only extract the class public methods, so we omit the keys of the `Feature` base