isaacscript-common 31.2.4 → 31.3.0

package/dist/index.rollup.d.ts

@@ -1470,12 +1470,12 @@ export declare function checkFamiliar(player: EntityPlayer, collectibleType: Col
 export declare function checkFamiliarFromCollectibles(player: EntityPlayer, collectibleType: CollectibleType, familiarVariant: FamiliarVariant, familiarSubType?: int): void;
 
 /**
- * Helper function to normalize an integer.
+ * Helper function to normalize a number, ensuring that it is within a certain range.
  *
- * - If `x` is less than `min`, then it will be clamped to `min`.
- * - If `x` is greater than `max`, then it will be clamped to `max`.
+ * - If `num` is less than `min`, then it will be clamped to `min`.
+ * - If `num` is greater than `max`, then it will be clamped to `max`.
  */
-export declare function clamp(x: int, min: int, max: int): int;
+export declare function clamp(num: int, min: int, max: int): int;
 
 export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 
@@ -4053,10 +4053,19 @@ export declare type EntityID = string & {
 
 /**
  * Helper function to return an array of integers with the specified range, inclusive on the lower
- * end and exclusive on the high end. (The "e" in the function name stands for exclusive.)
+ * end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
+ * this function works in a similar way as the built-in `range` function from Python.
  *
- * - For example, `eRange(1, 3)` will return `[1, 2]`.
- * - For example, `eRange(2)` will return `[0, 1]`.
+ * If the end is lower than the start, then the range will be reversed.
+ *
+ * For example:
+ *
+ * - `eRange(2)` returns `[0, 1]`.
+ * - `eRange(3)` returns `[0, 1, 2]`.
+ * - `eRange(-3)` returns `[0, -1, -2]`.
+ * - `eRange(1, 3)` returns `[1, 2]`.
+ * - `eRange(2, 5)` returns `[2, 3, 4]`.
+ * - `eRange(5, 2)` returns `[5, 4, 3]`.
  *
  * @param start The integer to start at.
  * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
@@ -4219,8 +4228,8 @@ export declare function filter<T>(array: T[], func: (value: T, index: number, ar
  * function that transforms a value, but return `undefined` if the value should be skipped. (Thus,
  * this function cannot be used in situations where `undefined` can be a valid array element.)
  *
- * This function is useful because a map will always produce an array with the same amount of
- * elements as the original array.
+ * This function is useful because the `Array.map` method will always produce an array with the same
+ * amount of elements as the original array.
  *
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
@@ -7696,8 +7705,16 @@ export declare function inStartingRoom(): boolean;
  * Helper function to return an array of integers with the specified range, inclusive on both ends.
  * (The "i" in the function name stands for inclusive.)
  *
- * - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
- * - For example, `iRange(2)` will return `[0, 1, 2]`.
+ * If the end is lower than the start, then the range will be reversed.
+ *
+ * For example:
+ *
+ * - `iRange(2)` returns `[0, 1, 2]`.
+ * - `iRange(3)` returns `[0, 1, 2, 3]`.
+ * - `iRange(-3)` returns `[0, -1, -2, -3]`.
+ * - `iRange(1, 3)` returns `[1, 2, 3]`.
+ * - `iRange(2, 5)` returns `[2, 3, 4, 5]`.
+ * - `iRange(5, 2)` returns `[5, 4, 3, 2]`.
  *
  * @param start The integer to start at.
  * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 31.2.4
+isaacscript-common 31.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -16582,14 +16582,24 @@ function ____exports.eRange(self, start, ____end, increment)
         increment = 1
     end
     if ____end == nil then
-        return ____exports.eRange(nil, 0, start)
+        return ____exports.eRange(nil, 0, start, increment)
     end
     local array = {}
-    do
-        local i = start
-        while i < ____end do
-            array[#array + 1] = i
-            i = i + increment
+    if start < ____end then
+        do
+            local i = start
+            while i < ____end do
+                array[#array + 1] = i
+                i = i + increment
+            end
+        end
+    else
+        do
+            local i = start
+            while i > ____end do
+                array[#array + 1] = i
+                i = i - increment
+            end
         end
     end
     return array
@@ -16606,9 +16616,10 @@ function ____exports.iRange(self, start, ____end, increment)
         increment = 1
     end
     if ____end == nil then
-        return ____exports.iRange(nil, 0, start)
+        return ____exports.iRange(nil, 0, start, increment)
     end
-    local exclusiveEnd = ____end + 1
+    local rangeIncreasing = start <= ____end
+    local exclusiveEnd = rangeIncreasing and ____end + 1 or ____end - 1
     return ____exports.eRange(nil, start, exclusiveEnd, increment)
 end
 function ____exports.inRange(self, num, start, ____end)
@@ -17022,7 +17033,8 @@ end
 function ____exports.sumArray(self, array)
     return __TS__ArrayReduce(
         array,
-        function(____, accumulator, element) return accumulator + element end
+        function(____, accumulator, element) return accumulator + element end,
+        0
     )
 end
 return ____exports
@@ -22365,10 +22377,10 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescri
 local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____direction = require("src.functions.direction")
 local directionToVector = ____direction.directionToVector
-function ____exports.clamp(self, x, min, max)
+function ____exports.clamp(self, num, min, max)
     return math.max(
         min,
-        math.min(x, max)
+        math.min(num, max)
     )
 end
 function ____exports.getAngleDifference(self, angle1, angle2)

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

@@ -98,8 +98,8 @@ export declare function emptyArray<T>(array: T[]): void;
  * function that transforms a value, but return `undefined` if the value should be skipped. (Thus,
  * this function cannot be used in situations where `undefined` can be a valid array element.)
  *
- * This function is useful because a map will always produce an array with the same amount of
- * elements as the original array.
+ * This function is useful because the `Array.map` method will always produce an array with the same
+ * amount of elements as the original array.
  *
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html

package/dist/src/functions/array.lua

@@ -294,8 +294,8 @@ end
 -- function that transforms a value, but return `undefined` if the value should be skipped. (Thus,
 -- this function cannot be used in situations where `undefined` can be a valid array element.)
 -- 
--- This function is useful because a map will always produce an array with the same amount of
--- elements as the original array.
+-- This function is useful because the `Array.map` method will always produce an array with the same
+-- amount of elements as the original array.
 -- 
 -- This is named `filterMap` after the Rust function:
 -- https://doc.rust-lang.org/std/iter/struct.FilterMap.html
@@ -516,7 +516,8 @@ end
 function ____exports.sumArray(self, array)
     return __TS__ArrayReduce(
         array,
-        function(____, accumulator, element) return accumulator + element end
+        function(____, accumulator, element) return accumulator + element end,
+        0
     )
 end
 return ____exports

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

@@ -1,11 +1,11 @@
 import { Direction } from "isaac-typescript-definitions";
 /**
- * Helper function to normalize an integer.
+ * Helper function to normalize a number, ensuring that it is within a certain range.
  *
- * - If `x` is less than `min`, then it will be clamped to `min`.
- * - If `x` is greater than `max`, then it will be clamped to `max`.
+ * - If `num` is less than `min`, then it will be clamped to `min`.
+ * - If `num` is greater than `max`, then it will be clamped to `max`.
  */
-export declare function clamp(x: int, min: int, max: int): int;
+export declare function clamp(num: int, min: int, max: int): int;
 export declare function getAngleDifference(angle1: float, angle2: float): float;
 /**
  * Helper function to get an array of equidistant points on the circumference around a circle.

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

@@ -1 +1 @@
-{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../../src/functions/math.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAGzD;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAErD;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,KAAK,CAGtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,GAAG,EACd,WAAW,SAAI,EACf,WAAW,SAAI,EACf,gBAAgB,YAAe,GAC9B,MAAM,EAAE,CAaV;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,GAClB,OAAO,CAOT;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,KAAK,EACnB,gBAAgB,EAAE,MAAM,EACxB,oBAAoB,EAAE,MAAM,GAC3B,OAAO,CAgBT;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGxC;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGvC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,MAAM,CAE7D;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,KAAK,GACb,MAAM,CAER;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,gBAAgB,SAAI,GAAG,KAAK,CAG7D;AAED,wEAAwE;AACxE,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAUnC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEtC"}
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../../src/functions/math.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAGzD;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAEvD;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,KAAK,CAGtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,GAAG,EACd,WAAW,SAAI,EACf,WAAW,SAAI,EACf,gBAAgB,YAAe,GAC9B,MAAM,EAAE,CAaV;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,GAClB,OAAO,CAOT;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,KAAK,EACnB,gBAAgB,EAAE,MAAM,EACxB,oBAAoB,EAAE,MAAM,GAC3B,OAAO,CAgBT;AAED,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGxC;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAGvC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,MAAM,CAE7D;AAED,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,KAAK,GACb,MAAM,CAER;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,gBAAgB,SAAI,GAAG,KAAK,CAG7D;AAED,wEAAwE;AACxE,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAUnC;AAED,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEtC"}

package/dist/src/functions/math.lua

@@ -3,14 +3,14 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____direction = require("src.functions.direction")
 local directionToVector = ____direction.directionToVector
---- Helper function to normalize an integer.
+--- Helper function to normalize a number, ensuring that it is within a certain range.
 -- 
--- - If `x` is less than `min`, then it will be clamped to `min`.
--- - If `x` is greater than `max`, then it will be clamped to `max`.
-function ____exports.clamp(self, x, min, max)
+-- - If `num` is less than `min`, then it will be clamped to `min`.
+-- - If `num` is greater than `max`, then it will be clamped to `max`.
+function ____exports.clamp(self, num, min, max)
     return math.max(
         min,
-        math.min(x, max)
+        math.min(num, max)
     )
 end
 function ____exports.getAngleDifference(self, angle1, angle2)

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

@@ -1,10 +1,19 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to return an array of integers with the specified range, inclusive on the lower
- * end and exclusive on the high end. (The "e" in the function name stands for exclusive.)
+ * end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
+ * this function works in a similar way as the built-in `range` function from Python.
  *
- * - For example, `eRange(1, 3)` will return `[1, 2]`.
- * - For example, `eRange(2)` will return `[0, 1]`.
+ * If the end is lower than the start, then the range will be reversed.
+ *
+ * For example:
+ *
+ * - `eRange(2)` returns `[0, 1]`.
+ * - `eRange(3)` returns `[0, 1, 2]`.
+ * - `eRange(-3)` returns `[0, -1, -2]`.
+ * - `eRange(1, 3)` returns `[1, 2]`.
+ * - `eRange(2, 5)` returns `[2, 3, 4]`.
+ * - `eRange(5, 2)` returns `[5, 4, 3]`.
  *
  * @param start The integer to start at.
  * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
@@ -21,8 +30,16 @@ export declare function getTraversalDescription(key: unknown, traversalDescripti
  * Helper function to return an array of integers with the specified range, inclusive on both ends.
  * (The "i" in the function name stands for inclusive.)
  *
- * - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
- * - For example, `iRange(2)` will return `[0, 1, 2]`.
+ * If the end is lower than the start, then the range will be reversed.
+ *
+ * For example:
+ *
+ * - `iRange(2)` returns `[0, 1, 2]`.
+ * - `iRange(3)` returns `[0, 1, 2, 3]`.
+ * - `iRange(-3)` returns `[0, -1, -2, -3]`.
+ * - `iRange(1, 3)` returns `[1, 2, 3]`.
+ * - `iRange(2, 5)` returns `[2, 3, 4, 5]`.
+ * - `iRange(5, 2)` returns `[5, 4, 3, 2]`.
  *
  * @param start The integer to start at.
  * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the

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

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/functions/utils.ts"],"names":[],"mappings":";AAMA;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAWlE;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,CAOlE;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,aAAa,IAAI,OAAO,CAMvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAI5C;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAetC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI3D;AAED;;;;;;;;;;;;;;GAcG;AAEH,wBAAgB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAG"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/functions/utils.ts"],"names":[],"mappings":";AAMA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAkBlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAQlE;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,aAAa,IAAI,OAAO,CAMvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAI5C;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAetC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI3D;AAED;;;;;;;;;;;;;;GAcG;AAEH,wBAAgB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAG"}

package/dist/src/functions/utils.lua

@@ -13,10 +13,19 @@ local getAllPlayers = ____playerIndex.getAllPlayers
 local ____types = require("src.functions.types")
 local isFunction = ____types.isFunction
 --- Helper function to return an array of integers with the specified range, inclusive on the lower
--- end and exclusive on the high end. (The "e" in the function name stands for exclusive.)
+-- end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
+-- this function works in a similar way as the built-in `range` function from Python.
 -- 
--- - For example, `eRange(1, 3)` will return `[1, 2]`.
--- - For example, `eRange(2)` will return `[0, 1]`.
+-- If the end is lower than the start, then the range will be reversed.
+-- 
+-- For example:
+-- 
+-- - `eRange(2)` returns `[0, 1]`.
+-- - `eRange(3)` returns `[0, 1, 2]`.
+-- - `eRange(-3)` returns `[0, -1, -2]`.
+-- - `eRange(1, 3)` returns `[1, 2]`.
+-- - `eRange(2, 5)` returns `[2, 3, 4]`.
+-- - `eRange(5, 2)` returns `[5, 4, 3]`.
 -- 
 -- @param start The integer to start at.
 -- @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
@@ -27,14 +36,24 @@ function ____exports.eRange(self, start, ____end, increment)
         increment = 1
     end
     if ____end == nil then
-        return ____exports.eRange(nil, 0, start)
+        return ____exports.eRange(nil, 0, start, increment)
     end
     local array = {}
-    do
-        local i = start
-        while i < ____end do
-            array[#array + 1] = i
-            i = i + increment
+    if start < ____end then
+        do
+            local i = start
+            while i < ____end do
+                array[#array + 1] = i
+                i = i + increment
+            end
+        end
+    else
+        do
+            local i = start
+            while i > ____end do
+                array[#array + 1] = i
+                i = i - increment
+            end
         end
     end
     return array
@@ -51,8 +70,16 @@ end
 --- Helper function to return an array of integers with the specified range, inclusive on both ends.
 -- (The "i" in the function name stands for inclusive.)
 -- 
--- - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
--- - For example, `iRange(2)` will return `[0, 1, 2]`.
+-- If the end is lower than the start, then the range will be reversed.
+-- 
+-- For example:
+-- 
+-- - `iRange(2)` returns `[0, 1, 2]`.
+-- - `iRange(3)` returns `[0, 1, 2, 3]`.
+-- - `iRange(-3)` returns `[0, -1, -2, -3]`.
+-- - `iRange(1, 3)` returns `[1, 2, 3]`.
+-- - `iRange(2, 5)` returns `[2, 3, 4, 5]`.
+-- - `iRange(5, 2)` returns `[5, 4, 3, 2]`.
 -- 
 -- @param start The integer to start at.
 -- @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
@@ -63,9 +90,10 @@ function ____exports.iRange(self, start, ____end, increment)
         increment = 1
     end
     if ____end == nil then
-        return ____exports.iRange(nil, 0, start)
+        return ____exports.iRange(nil, 0, start, increment)
     end
-    local exclusiveEnd = ____end + 1
+    local rangeIncreasing = start <= ____end
+    local exclusiveEnd = rangeIncreasing and ____end + 1 or ____end - 1
     return ____exports.eRange(nil, start, exclusiveEnd, increment)
 end
 --- Helper function to check if a variable is within a certain range, inclusive on both ends.

package/package.json

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

package/src/functions/array.ts

@@ -237,8 +237,8 @@ export function emptyArray<T>(array: T[]): void {
  * function that transforms a value, but return `undefined` if the value should be skipped. (Thus,
  * this function cannot be used in situations where `undefined` can be a valid array element.)
  *
- * This function is useful because a map will always produce an array with the same amount of
- * elements as the original array.
+ * This function is useful because the `Array.map` method will always produce an array with the same
+ * amount of elements as the original array.
  *
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
@@ -560,7 +560,7 @@ export function shuffleArrayInPlace<T>(
 
 /** Helper function to sum every value in an array together. */
 export function sumArray(array: number[] | readonly number[]): number {
-  return array.reduce((accumulator, element) => accumulator + element);
+  return array.reduce((accumulator, element) => accumulator + element, 0);
 }
 
 /**

package/src/functions/math.ts

@@ -2,13 +2,13 @@ import { Direction } from "isaac-typescript-definitions";
 import { directionToVector } from "./direction";
 
 /**
- * Helper function to normalize an integer.
+ * Helper function to normalize a number, ensuring that it is within a certain range.
  *
- * - If `x` is less than `min`, then it will be clamped to `min`.
- * - If `x` is greater than `max`, then it will be clamped to `max`.
+ * - If `num` is less than `min`, then it will be clamped to `min`.
+ * - If `num` is greater than `max`, then it will be clamped to `max`.
  */
-export function clamp(x: int, min: int, max: int): int {
-  return Math.max(min, Math.min(x, max));
+export function clamp(num: int, min: int, max: int): int {
+  return Math.max(min, Math.min(num, max));
 }
 
 export function getAngleDifference(angle1: float, angle2: float): float {

package/src/functions/utils.ts

@@ -6,10 +6,19 @@ import { isFunction } from "./types";
 
 /**
  * Helper function to return an array of integers with the specified range, inclusive on the lower
- * end and exclusive on the high end. (The "e" in the function name stands for exclusive.)
+ * end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
+ * this function works in a similar way as the built-in `range` function from Python.
  *
- * - For example, `eRange(1, 3)` will return `[1, 2]`.
- * - For example, `eRange(2)` will return `[0, 1]`.
+ * If the end is lower than the start, then the range will be reversed.
+ *
+ * For example:
+ *
+ * - `eRange(2)` returns `[0, 1]`.
+ * - `eRange(3)` returns `[0, 1, 2]`.
+ * - `eRange(-3)` returns `[0, -1, -2]`.
+ * - `eRange(1, 3)` returns `[1, 2]`.
+ * - `eRange(2, 5)` returns `[2, 3, 4]`.
+ * - `eRange(5, 2)` returns `[5, 4, 3]`.
  *
  * @param start The integer to start at.
  * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
@@ -18,12 +27,19 @@ import { isFunction } from "./types";
  */
 export function eRange(start: int, end?: int, increment = 1): int[] {
   if (end === undefined) {
-    return eRange(0, start);
+    return eRange(0, start, increment);
   }
 
   const array: int[] = [];
-  for (let i = start; i < end; i += increment) {
-    array.push(i);
+
+  if (start < end) {
+    for (let i = start; i < end; i += increment) {
+      array.push(i);
+    }
+  } else {
+    for (let i = start; i > end; i -= increment) {
+      array.push(i);
+    }
   }
 
   return array;
@@ -50,8 +66,16 @@ export function getTraversalDescription(
  * Helper function to return an array of integers with the specified range, inclusive on both ends.
  * (The "i" in the function name stands for inclusive.)
  *
- * - For example, `iRange(1, 3)` will return `[1, 2, 3]`.
- * - For example, `iRange(2)` will return `[0, 1, 2]`.
+ * If the end is lower than the start, then the range will be reversed.
+ *
+ * For example:
+ *
+ * - `iRange(2)` returns `[0, 1, 2]`.
+ * - `iRange(3)` returns `[0, 1, 2, 3]`.
+ * - `iRange(-3)` returns `[0, -1, -2, -3]`.
+ * - `iRange(1, 3)` returns `[1, 2, 3]`.
+ * - `iRange(2, 5)` returns `[2, 3, 4, 5]`.
+ * - `iRange(5, 2)` returns `[5, 4, 3, 2]`.
  *
  * @param start The integer to start at.
  * @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
@@ -60,10 +84,11 @@ export function getTraversalDescription(
  */
 export function iRange(start: int, end?: int, increment = 1): int[] {
   if (end === undefined) {
-    return iRange(0, start);
+    return iRange(0, start, increment);
   }
 
-  const exclusiveEnd = end + 1;
+  const rangeIncreasing = start <= end;
+  const exclusiveEnd = rangeIncreasing ? end + 1 : end - 1;
   return eRange(start, exclusiveEnd, increment);
 }