isaacscript-common 18.4.0 → 19.0.0

package/dist/index.d.ts

@@ -6857,19 +6857,6 @@ export declare function inDimension(dimension: Dimension): boolean;
 
 export declare function inDoubleTrouble(): boolean;
 
-/**
- * Helper function to check if a variable is within a certain range, exclusive on both ends. (The
- * "e" stands for exclusive.)
- *
- * - For example, `inERange(1, 1, 3)` will return `false`.
- * - For example, `inERange(1.01, 1, 3)` will return `true`.
- *
- * @param num The number to check.
- * @param start The start of the range to check.
- * @param end The end of the range to check.
- */
-export declare function inERange(num: int, start: int, end: int): boolean;
-
 export declare function inGenesisRoom(): boolean;
 
 /**
@@ -6880,19 +6867,6 @@ export declare function inGenesisRoom(): boolean;
  */
 export declare function inHomeCloset(): boolean;
 
-/**
- * Helper function to check if a variable is within a certain range, inclusive on both ends. (The
- * "i" stands for inclusive.)
- *
- * - For example, `inIRange(1, 1, 3)` will return `true`.
- * - For example, `inIRange(0, 1, 3)` will return `false`.
- *
- * @param num The number to check.
- * @param start The start of the range to check.
- * @param end The end of the range to check.
- */
-export declare function inIRange(num: int, start: int, end: int): boolean;
-
 /**
  * Initializes an array with all of the elements containing the specified default value.
  *
@@ -6934,6 +6908,18 @@ export declare function inMinibossRoomOf(minibossID: MinibossID): boolean;
  */
 export declare function inMirrorRoom(): boolean;
 
+/**
+ * Helper function to check if a variable is within a certain range, inclusive on both ends.
+ *
+ * - For example, `inRange(1, 1, 3)` will return `true`.
+ * - For example, `inRange(0, 1, 3)` will return `false`.
+ *
+ * @param num The number to check.
+ * @param start The start of the range to check.
+ * @param end The end of the range to check.
+ */
+export declare function inRange(num: int, start: int, end: int): boolean;
+
 /**
  * Helper function to check if a given position is within a given rectangle.
  *
@@ -11556,6 +11542,12 @@ export declare function onSetSeed(): boolean;
 
 export declare function onSheol(): 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;
+
 /**
  * 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 18.4.0
+isaacscript-common 19.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -15343,10 +15343,7 @@ function ____exports.iRange(self, start, ____end, increment)
     end
     return array
 end
-function ____exports.inERange(self, num, start, ____end)
-    return num > start and num < ____end
-end
-function ____exports.inIRange(self, num, start, ____end)
+function ____exports.inRange(self, num, start, ____end)
     return num >= start and num <= ____end
 end
 function ____exports.isReflectionRender(self)
@@ -25438,6 +25435,8 @@ local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
 local ____types = require("src.functions.types")
 local asLevelStage = ____types.asLevelStage
 local asNumber = ____types.asNumber
+local ____utils = require("src.functions.utils")
+local inRange = ____utils.inRange
 function ____exports.isRepentanceStage(self, stageType)
     return stageType == StageType.REPENTANCE or stageType == StageType.REPENTANCE_B
 end
@@ -25549,6 +25548,10 @@ function ____exports.onSheol(self)
     local stageType = level:GetStageType()
     return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.ORIGINAL
 end
+function ____exports.onStageWithNaturalDevilRoom(self)
+    local effectiveStage = ____exports.getEffectiveStage(nil)
+    return inRange(nil, effectiveStage, 2, 8)
+end
 function ____exports.setStage(self, stage, stageType, reseed)
     if reseed == nil then
         reseed = false

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

@@ -69,6 +69,11 @@ export declare function onFirstFloor(): boolean;
  */
 export declare function onRepentanceStage(): boolean;
 export declare function onSheol(): 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 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,SAAS,EACV,MAAM,8BAA8B,CAAC;AAQtC;;;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,GAAG,CASvC;AAGD;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,MAAM,CAG3E;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;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;;;;;;;;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,SAAS,EACV,MAAM,8BAA8B,CAAC;AAStC;;;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,GAAG,CASvC;AAGD;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,MAAM,CAG3E;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;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;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAGrD;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

@@ -16,6 +16,8 @@ local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
 local ____types = require("src.functions.types")
 local asLevelStage = ____types.asLevelStage
 local asNumber = ____types.asNumber
+local ____utils = require("src.functions.utils")
+local inRange = ____utils.inRange
 --- Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
 -- `StageType.REPENTANCE_B`.
 function ____exports.isRepentanceStage(self, stageType)
@@ -166,6 +168,12 @@ 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 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, 2, 8)
+end
 --- Helper function to warp to a new stage/level.
 -- 
 -- @param stage The stage number to warp to.

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

@@ -31,29 +31,16 @@ export declare function getTraversalDescription(key: unknown, traversalDescripti
  */
 export declare function iRange(start: int, end?: int, increment?: number): int[];
 /**
- * Helper function to check if a variable is within a certain range, exclusive on both ends. (The
- * "e" stands for exclusive.)
+ * Helper function to check if a variable is within a certain range, inclusive on both ends.
  *
- * - For example, `inERange(1, 1, 3)` will return `false`.
- * - For example, `inERange(1.01, 1, 3)` will return `true`.
+ * - For example, `inRange(1, 1, 3)` will return `true`.
+ * - For example, `inRange(0, 1, 3)` will return `false`.
  *
  * @param num The number to check.
  * @param start The start of the range to check.
  * @param end The end of the range to check.
  */
-export declare function inERange(num: int, start: int, end: int): boolean;
-/**
- * Helper function to check if a variable is within a certain range, inclusive on both ends. (The
- * "i" stands for inclusive.)
- *
- * - For example, `inIRange(1, 1, 3)` will return `true`.
- * - For example, `inIRange(0, 1, 3)` will return `false`.
- *
- * @param num The number to check.
- * @param start The start of the range to check.
- * @param end The end of the range to check.
- */
-export declare function inIRange(num: int, start: int, end: int): boolean;
+export declare function inRange(num: int, start: int, end: int): boolean;
 /**
  * Helper function to see if the current render callback is rendering a water reflection.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/functions/utils.ts"],"names":[],"mappings":";AAIA;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAYlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAYlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAEhE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAEhE;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAI5C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAE9C;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAGxE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI3D;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAG;AAEjD;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAqB1E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,4BAA4B,CAE1C,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/functions/utils.ts"],"names":[],"mappings":";AAIA;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAYlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAYlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAE/D;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAI5C;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAE9C;AAED,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAGxE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI3D;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAG;AAEjD;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAqB1E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,4BAA4B,CAE1C,CAAC,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAC/B,IAAI,SAAS,MAAM,GAAG,MAAM,KACzB,IAAI,CAAG"}

package/dist/src/functions/utils.lua

@@ -70,28 +70,15 @@ function ____exports.iRange(self, start, ____end, increment)
     end
     return array
 end
---- Helper function to check if a variable is within a certain range, exclusive on both ends. (The
--- "e" stands for exclusive.)
+--- Helper function to check if a variable is within a certain range, inclusive on both ends.
 -- 
--- - For example, `inERange(1, 1, 3)` will return `false`.
--- - For example, `inERange(1.01, 1, 3)` will return `true`.
+-- - For example, `inRange(1, 1, 3)` will return `true`.
+-- - For example, `inRange(0, 1, 3)` will return `false`.
 -- 
 -- @param num The number to check.
 -- @param start The start of the range to check.
 -- @param end The end of the range to check.
-function ____exports.inERange(self, num, start, ____end)
-    return num > start and num < ____end
-end
---- Helper function to check if a variable is within a certain range, inclusive on both ends. (The
--- "i" stands for inclusive.)
--- 
--- - For example, `inIRange(1, 1, 3)` will return `true`.
--- - For example, `inIRange(0, 1, 3)` will return `false`.
--- 
--- @param num The number to check.
--- @param start The start of the range to check.
--- @param end The end of the range to check.
-function ____exports.inIRange(self, num, start, ____end)
+function ____exports.inRange(self, num, start, ____end)
     return num >= start and num <= ____end
 end
 --- Helper function to see if the current render callback is rendering a water reflection.

package/package.json

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

package/src/functions/stage.ts

@@ -10,6 +10,7 @@ import { ROOM_TYPE_GOTO_PREFIXES } from "../objects/roomTypeGotoPrefixes";
 import { STAGE_TYPE_SUFFIXES } from "../objects/stageTypeSuffixes";
 import { STAGE_TYPE_TO_LETTER } from "../objects/stageTypeToLetter";
 import { asLevelStage, asNumber } from "./types";
+import { inRange } from "./utils";
 
 /**
  * Helper function that calculates what the stage type should be for the provided stage. This
@@ -247,6 +248,15 @@ export function onSheol(): 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 function onStageWithNaturalDevilRoom(): boolean {
+  const effectiveStage = getEffectiveStage();
+  return inRange(effectiveStage, 2, 8);
+}
+
 /**
  * Helper function to warp to a new stage/level.
  *

package/src/functions/utils.ts

@@ -72,32 +72,16 @@ export function iRange(start: int, end?: int, increment = 1): int[] {
 }
 
 /**
- * Helper function to check if a variable is within a certain range, exclusive on both ends. (The
- * "e" stands for exclusive.)
+ * Helper function to check if a variable is within a certain range, inclusive on both ends.
  *
- * - For example, `inERange(1, 1, 3)` will return `false`.
- * - For example, `inERange(1.01, 1, 3)` will return `true`.
+ * - For example, `inRange(1, 1, 3)` will return `true`.
+ * - For example, `inRange(0, 1, 3)` will return `false`.
  *
  * @param num The number to check.
  * @param start The start of the range to check.
  * @param end The end of the range to check.
  */
-export function inERange(num: int, start: int, end: int): boolean {
-  return num > start && num < end;
-}
-
-/**
- * Helper function to check if a variable is within a certain range, inclusive on both ends. (The
- * "i" stands for inclusive.)
- *
- * - For example, `inIRange(1, 1, 3)` will return `true`.
- * - For example, `inIRange(0, 1, 3)` will return `false`.
- *
- * @param num The number to check.
- * @param start The start of the range to check.
- * @param end The end of the range to check.
- */
-export function inIRange(num: int, start: int, end: int): boolean {
+export function inRange(num: int, start: int, end: int): boolean {
   return num >= start && num <= end;
 }