isaacscript-common 28.2.0 → 28.3.0

package/dist/index.rollup.d.ts

@@ -12728,6 +12728,10 @@ export declare const NUM_VANILLA_PILL_EFFECTS: number;
 /** Calculated from the `TrinketType` enum. (`TrinketType.NULL` is not included.) */
 export declare const NUM_VANILLA_TRINKET_TYPES: number;
 
+/**
+ * Helper function to check if the player has taken Dad's Note. This sets the game state flag of
+ * `GameStateFlag.BACKWARDS_PATH` and causes floor generation to change.
+ */
 export declare function onAscent(): boolean;
 
 export declare function onCathedral(): boolean;
@@ -12738,6 +12742,14 @@ export declare function onDarkRoom(): boolean;
 
 export declare const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
 
+/**
+ * Helper function to check if the current room matches one of the given stages. This uses the
+ * `getEffectiveStage` helper function so that the Repentance floors are correctly adjusted.
+ *
+ * This function is variadic, which means you can pass as many stages as you want to match for.
+ */
+export declare function onEffectiveStage(...effectiveStages: LevelStage[]): boolean;
+
 /**
  * Returns whether or not the player is on the "final floor" of the particular run. The final floor
  * is defined as one that prevents the player from entering the I AM ERROR room on.
@@ -12772,18 +12784,43 @@ export declare function onSetSeed(): boolean;
 export declare function onSheol(): boolean;
 
 /**
- * Helper function to check if the current room matches one of the given room types.
+ * Helper function to check if the current room matches one of the given stages.
  *
- * This function is variadic, which means you can pass as many room types as you want to match for.
+ * This function is variadic, which means you can pass as many stages as you want to match for.
  */
 export declare function onStage(...stages: LevelStage[]): boolean;
 
+/**
+ * Helper function to check if the current room matches one of the given stage types.
+ *
+ * This function is variadic, which means you can pass as many room types as you want to match for.
+ */
+export declare function onStageType(...stageTypes: StageType[]): boolean;
+
 /**
  * Helper function to check if the current stage is one that has the possibility to grant a natural
  * Devil Room or Angel Room after killing the boss.
  */
 export declare function onStageWithNaturalDevilRoom(): boolean;
 
+/**
+ * Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
+ * defeating the boss.
+ */
+export declare function onStageWithSecretExitToDownpour(): boolean;
+
+/**
+ * Helper function to check if the current stage will spawn a spiked door to Mausoleum/Gehenna after
+ * defeating the boss.
+ */
+export declare function onStageWithSecretExitToMausoleum(): boolean;
+
+/**
+ * Helper function to check if the current stage will spawn a wooden door to Mines/Ashpit after
+ * defeating the boss.
+ */
+export declare function onStageWithSecretExitToMines(): boolean;
+
 /**
  * For the purposes of this function, doors to Secret Rooms or Super Secret Rooms that have not been
  * discovered yet will not be opened.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 28.2.0
+isaacscript-common 28.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -26938,6 +26938,14 @@ function ____exports.onDarkRoom(self)
     local stageType = level:GetStageType()
     return stage == LevelStage.DARK_ROOM_CHEST and stageType == StageType.ORIGINAL
 end
+function ____exports.onEffectiveStage(self, ...)
+    local effectiveStages = {...}
+    local thisEffectiveStage = ____exports.getEffectiveStage(nil)
+    return __TS__ArraySome(
+        effectiveStages,
+        function(____, effectiveStage) return effectiveStage == thisEffectiveStage end
+    )
+end
 function ____exports.onFinalFloor(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
@@ -26963,10 +26971,36 @@ function ____exports.onStage(self, ...)
         function(____, stage) return stage == thisStage end
     )
 end
+function ____exports.onStageType(self, ...)
+    local stageTypes = {...}
+    local level = game:GetLevel()
+    local thisStageType = level:GetStageType()
+    return __TS__ArraySome(
+        stageTypes,
+        function(____, stageType) return stageType == thisStageType end
+    )
+end
 function ____exports.onStageWithNaturalDevilRoom(self)
     local effectiveStage = ____exports.getEffectiveStage(nil)
     return inRange(nil, effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2) and effectiveStage ~= LevelStage.BLUE_WOMB
 end
+function ____exports.onStageWithSecretExitToDownpour(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage == LevelStage.BASEMENT_1 or stage == LevelStage.BASEMENT_2
+end
+function ____exports.onStageWithSecretExitToMausoleum(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local repentanceStage = ____exports.onRepentanceStage(nil)
+    return stage == LevelStage.DEPTHS_1 and not repentanceStage or stage == LevelStage.CAVES_2 and repentanceStage
+end
+function ____exports.onStageWithSecretExitToMines(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local repentanceStage = ____exports.onRepentanceStage(nil)
+    return stage == LevelStage.CAVES_1 and not repentanceStage or stage == LevelStage.BASEMENT_2 and repentanceStage
+end
 function ____exports.setStage(self, stage, stageType, reseed)
     if reseed == nil then
         reseed = false

package/dist/src/functions/stage.d.ts

@@ -60,10 +60,21 @@ export declare function goToStage(stage: LevelStage, stageType: StageType): void
  * `StageType.REPENTANCE_B`.
  */
 export declare function isRepentanceStage(stageType: StageType): boolean;
+/**
+ * Helper function to check if the player has taken Dad's Note. This sets the game state flag of
+ * `GameStateFlag.BACKWARDS_PATH` and causes floor generation to change.
+ */
 export declare function onAscent(): boolean;
 export declare function onCathedral(): boolean;
 export declare function onChest(): boolean;
 export declare function onDarkRoom(): boolean;
+/**
+ * Helper function to check if the current room matches one of the given stages. This uses the
+ * `getEffectiveStage` helper function so that the Repentance floors are correctly adjusted.
+ *
+ * This function is variadic, which means you can pass as many stages as you want to match for.
+ */
+export declare function onEffectiveStage(...effectiveStages: LevelStage[]): boolean;
 /**
  * Returns whether or not the player is on the "final floor" of the particular run. The final floor
  * is defined as one that prevents the player from entering the I AM ERROR room on.
@@ -87,16 +98,37 @@ export declare function onFirstFloor(): boolean;
 export declare function onRepentanceStage(): boolean;
 export declare function onSheol(): boolean;
 /**
- * Helper function to check if the current room matches one of the given room types.
+ * Helper function to check if the current room matches one of the given stages.
  *
- * This function is variadic, which means you can pass as many room types as you want to match for.
+ * This function is variadic, which means you can pass as many stages as you want to match for.
  */
 export declare function onStage(...stages: LevelStage[]): boolean;
+/**
+ * Helper function to check if the current room matches one of the given stage types.
+ *
+ * This function is variadic, which means you can pass as many room types as you want to match for.
+ */
+export declare function onStageType(...stageTypes: StageType[]): boolean;
 /**
  * Helper function to check if the current stage is one that has the possibility to grant a natural
  * Devil Room or Angel Room after killing the boss.
  */
 export declare function onStageWithNaturalDevilRoom(): boolean;
+/**
+ * Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
+ * defeating the boss.
+ */
+export declare function onStageWithSecretExitToDownpour(): boolean;
+/**
+ * Helper function to check if the current stage will spawn a spiked door to Mausoleum/Gehenna after
+ * defeating the boss.
+ */
+export declare function onStageWithSecretExitToMausoleum(): boolean;
+/**
+ * Helper function to check if the current stage will spawn a wooden door to Mines/Ashpit after
+ * defeating the boss.
+ */
+export declare function onStageWithSecretExitToMines(): boolean;
 /**
  * Helper function to warp to a new stage/level.
  *

package/dist/src/functions/stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAa7E;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxD;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAMrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAa7E;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,eAAe,EAAE,UAAU,EAAE,GAAG,OAAO,CAK1E;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAI/D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAMrD;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAS1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAStD;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}

package/dist/src/functions/stage.lua

@@ -156,6 +156,8 @@ function ____exports.goToStage(self, stage, stageType)
     local command = ("stage " .. tostring(stage)) .. stageTypeLetterSuffix
     Isaac.ExecuteCommand(command)
 end
+--- Helper function to check if the player has taken Dad's Note. This sets the game state flag of
+-- `GameStateFlag.BACKWARDS_PATH` and causes floor generation to change.
 function ____exports.onAscent(self)
     return game:GetStateFlag(GameStateFlag.BACKWARDS_PATH)
 end
@@ -177,6 +179,18 @@ function ____exports.onDarkRoom(self)
     local stageType = level:GetStageType()
     return stage == LevelStage.DARK_ROOM_CHEST and stageType == StageType.ORIGINAL
 end
+--- Helper function to check if the current room matches one of the given stages. This uses the
+-- `getEffectiveStage` helper function so that the Repentance floors are correctly adjusted.
+-- 
+-- This function is variadic, which means you can pass as many stages as you want to match for.
+function ____exports.onEffectiveStage(self, ...)
+    local effectiveStages = {...}
+    local thisEffectiveStage = ____exports.getEffectiveStage(nil)
+    return __TS__ArraySome(
+        effectiveStages,
+        function(____, effectiveStage) return effectiveStage == thisEffectiveStage end
+    )
+end
 --- Returns whether or not the player is on the "final floor" of the particular run. The final floor
 -- is defined as one that prevents the player from entering the I AM ERROR room on.
 -- 
@@ -203,9 +217,9 @@ function ____exports.onSheol(self)
     local stageType = level:GetStageType()
     return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.ORIGINAL
 end
---- Helper function to check if the current room matches one of the given room types.
+--- Helper function to check if the current room matches one of the given stages.
 -- 
--- This function is variadic, which means you can pass as many room types as you want to match for.
+-- This function is variadic, which means you can pass as many stages as you want to match for.
 function ____exports.onStage(self, ...)
     local stages = {...}
     local level = game:GetLevel()
@@ -215,12 +229,47 @@ function ____exports.onStage(self, ...)
         function(____, stage) return stage == thisStage end
     )
 end
+--- Helper function to check if the current room matches one of the given stage types.
+-- 
+-- This function is variadic, which means you can pass as many room types as you want to match for.
+function ____exports.onStageType(self, ...)
+    local stageTypes = {...}
+    local level = game:GetLevel()
+    local thisStageType = level:GetStageType()
+    return __TS__ArraySome(
+        stageTypes,
+        function(____, stageType) return stageType == thisStageType end
+    )
+end
 --- Helper function to check if the current stage is one that has the possibility to grant a natural
 -- Devil Room or Angel Room after killing the boss.
 function ____exports.onStageWithNaturalDevilRoom(self)
     local effectiveStage = ____exports.getEffectiveStage(nil)
     return inRange(nil, effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2) and effectiveStage ~= LevelStage.BLUE_WOMB
 end
+--- Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
+-- defeating the boss.
+function ____exports.onStageWithSecretExitToDownpour(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage == LevelStage.BASEMENT_1 or stage == LevelStage.BASEMENT_2
+end
+--- Helper function to check if the current stage will spawn a spiked door to Mausoleum/Gehenna after
+-- defeating the boss.
+function ____exports.onStageWithSecretExitToMausoleum(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local repentanceStage = ____exports.onRepentanceStage(nil)
+    return stage == LevelStage.DEPTHS_1 and not repentanceStage or stage == LevelStage.CAVES_2 and repentanceStage
+end
+--- Helper function to check if the current stage will spawn a wooden door to Mines/Ashpit after
+-- defeating the boss.
+function ____exports.onStageWithSecretExitToMines(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local repentanceStage = ____exports.onRepentanceStage(nil)
+    return stage == LevelStage.CAVES_1 and not repentanceStage or stage == LevelStage.BASEMENT_2 and repentanceStage
+end
 --- Helper function to warp to a new stage/level.
 -- 
 -- @param stage The stage number to warp to.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "28.2.0",
+  "version": "28.3.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/stage.ts

@@ -198,6 +198,10 @@ export function isRepentanceStage(stageType: StageType): boolean {
   );
 }
 
+/**
+ * Helper function to check if the player has taken Dad's Note. This sets the game state flag of
+ * `GameStateFlag.BACKWARDS_PATH` and causes floor generation to change.
+ */
 export function onAscent(): boolean {
   return game.GetStateFlag(GameStateFlag.BACKWARDS_PATH);
 }
@@ -234,6 +238,19 @@ export function onDarkRoom(): boolean {
   );
 }
 
+/**
+ * Helper function to check if the current room matches one of the given stages. This uses the
+ * `getEffectiveStage` helper function so that the Repentance floors are correctly adjusted.
+ *
+ * This function is variadic, which means you can pass as many stages as you want to match for.
+ */
+export function onEffectiveStage(...effectiveStages: LevelStage[]): boolean {
+  const thisEffectiveStage = getEffectiveStage();
+  return effectiveStages.some(
+    (effectiveStage) => effectiveStage === thisEffectiveStage,
+  );
+}
+
 /**
  * Returns whether or not the player is on the "final floor" of the particular run. The final floor
  * is defined as one that prevents the player from entering the I AM ERROR room on.
@@ -289,9 +306,9 @@ export function onSheol(): boolean {
 }
 
 /**
- * Helper function to check if the current room matches one of the given room types.
+ * Helper function to check if the current room matches one of the given stages.
  *
- * This function is variadic, which means you can pass as many room types as you want to match for.
+ * This function is variadic, which means you can pass as many stages as you want to match for.
  */
 export function onStage(...stages: LevelStage[]): boolean {
   const level = game.GetLevel();
@@ -299,6 +316,17 @@ export function onStage(...stages: LevelStage[]): boolean {
   return stages.some((stage) => stage === thisStage);
 }
 
+/**
+ * Helper function to check if the current room matches one of the given stage types.
+ *
+ * This function is variadic, which means you can pass as many room types as you want to match for.
+ */
+export function onStageType(...stageTypes: StageType[]): boolean {
+  const level = game.GetLevel();
+  const thisStageType = level.GetStageType();
+  return stageTypes.some((stageType) => stageType === thisStageType);
+}
+
 /**
  * Helper function to check if the current stage is one that has the possibility to grant a natural
  * Devil Room or Angel Room after killing the boss.
@@ -311,6 +339,47 @@ export function onStageWithNaturalDevilRoom(): boolean {
   );
 }
 
+/**
+ * Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
+ * defeating the boss.
+ */
+export function onStageWithSecretExitToDownpour(): boolean {
+  const level = game.GetLevel();
+  const stage = level.GetStage();
+
+  return stage === LevelStage.BASEMENT_1 || stage === LevelStage.BASEMENT_2;
+}
+
+/**
+ * Helper function to check if the current stage will spawn a spiked door to Mausoleum/Gehenna after
+ * defeating the boss.
+ */
+export function onStageWithSecretExitToMausoleum(): boolean {
+  const level = game.GetLevel();
+  const stage = level.GetStage();
+  const repentanceStage = onRepentanceStage();
+
+  return (
+    (stage === LevelStage.DEPTHS_1 && !repentanceStage) ||
+    (stage === LevelStage.CAVES_2 && repentanceStage)
+  );
+}
+
+/**
+ * Helper function to check if the current stage will spawn a wooden door to Mines/Ashpit after
+ * defeating the boss.
+ */
+export function onStageWithSecretExitToMines(): boolean {
+  const level = game.GetLevel();
+  const stage = level.GetStage();
+  const repentanceStage = onRepentanceStage();
+
+  return (
+    (stage === LevelStage.CAVES_1 && !repentanceStage) ||
+    (stage === LevelStage.BASEMENT_2 && repentanceStage)
+  );
+}
+
 /**
  * Helper function to warp to a new stage/level.
  *