isaacscript-common 27.3.0 → 27.5.0

package/dist/index.rollup.d.ts

@@ -2954,6 +2954,13 @@ declare class DebugDisplay extends Feature {
     togglePressurePlateDisplay(force?: boolean): void;
 }
 
+/**
+ * Helper type to subtract one from a number type.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export declare type Decrement<N extends number> = Tuple<N> extends [unknown, ...infer U] ? U["length"] : never;
+
 /**
  * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
  * of the nested references remain.
@@ -7144,6 +7151,13 @@ export declare function includes<T>(array: T[], element: T): boolean;
  */
 export declare function inCrawlSpace(): boolean;
 
+/**
+ * Helper type to add one to a number type.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export declare type Increment<N extends number> = [...Tuple<N>, unknown]["length"];
+
 /**
  * Helper function to detect if the current room is one of the rooms in the Death Certificate area.
  */
@@ -12053,6 +12067,14 @@ export declare enum MysteriousPaperEffect {
  */
 export declare type NaturalNumbersLessThan<N extends number, Acc extends number[] = []> = Acc["length"] extends N ? Acc[number] : NaturalNumbersLessThan<N, [...Acc, Acc["length"]]>;
 
+/**
+ * Helper type to get a range of integers between 0 and N.
+ *
+ * From:
+ * https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
+ */
+export declare type NaturalNumbersLessThanOrEqualTo<N extends number> = NaturalNumbersLessThan<Increment<N>>;
+
 /** This is near the top door. */
 export declare const NEW_FLOOR_STARTING_POSITION_GREED_MODE: Readonly<Vector>;
 
@@ -12919,13 +12941,14 @@ declare interface QueueElement {
 }
 
 /**
- * Helper type to get a range of integers between low and high. It is inclusive on the lower end and
- * exclusive on the higher end.
+ * Helper type to get a range of integers. It is inclusive on both ends.
+ *
+ * For example, `Range<3, 5>` will return `3 | 4 | 5`.
  *
  * From:
  * https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
  */
-export declare type Range<Low extends number, High extends number> = Exclude<NaturalNumbersLessThan<High>, NaturalNumbersLessThan<Low>>;
+export declare type Range<Low extends number, High extends number> = Exclude<NaturalNumbersLessThanOrEqualTo<High>, NaturalNumbersLessThan<Low>>;
 
 /** An alias for the `Map` constructor that returns a read-only map. */
 declare const ReadonlyMap_2: ReadonlyMapConstructor;
@@ -15691,6 +15714,15 @@ export declare interface TSTLClassMetatable {
     };
 }
 
+/**
+ * Helper type to represent a tuple of length N.
+ *
+ * This is used by the `Increment` and `Decrement` helper types.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export declare type Tuple<N extends number, T extends unknown[] = []> = T["length"] extends N ? T : Tuple<N, [...T, unknown]>;
+
 export declare type TupleToIntersection<T extends unknown[]> = T extends [
 infer F,
 ...infer R
@@ -15699,6 +15731,15 @@ infer F,
 /** Helper type to convert a tuple to a union. */
 export declare type TupleToUnion<T extends unknown[]> = T[number];
 
+/**
+ * Helper type that validates that a tuple does not have a length greater than N.
+ *
+ * For example, `TupleWithMaxLength<string, 3>` will allow string tuples of size 0, 1, 2, or 3.
+ */
+export declare type TupleWithMaxLength<T, MaxLength extends number> = (T[] | readonly T[]) & {
+    length: NaturalNumbersLessThanOrEqualTo<MaxLength>;
+};
+
 /**
  * This is the number of draw coordinates that each heart spans on the UI in the upper left hand
  * corner.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 27.3.0
+isaacscript-common 27.5.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -52250,10 +52250,22 @@ return ____exports
  end,
 ["src.types.AllButLast"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.Tuple"] = function(...) 
+local ____exports = {}
+return ____exports
+ end,
+["src.types.Decrement"] = function(...) 
+local ____exports = {}
 return ____exports
  end,
 ["src.types.HasFunction"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.Increment"] = function(...) 
+local ____exports = {}
 return ____exports
  end,
 ["src.types.StartsWithLowercase"] = function(...) 
@@ -52266,6 +52278,10 @@ return ____exports
  end,
 ["src.types.NaturalNumbersLessThan"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.NaturalNumbersLessThanOrEqualTo"] = function(...) 
+local ____exports = {}
 return ____exports
  end,
 ["src.types.Range"] = function(...) 
@@ -52278,6 +52294,10 @@ return ____exports
  end,
 ["src.types.TupleToUnion"] = function(...) 
 local ____exports = {}
+return ____exports
+ end,
+["src.types.TupleWithMaxLength"] = function(...) 
+local ____exports = {}
 return ____exports
  end,
 ["src.types.UnionToIntersection"] = function(...) 

package/dist/src/index.d.ts

@@ -153,12 +153,15 @@ export * from "./types/AnyFunction";
 export * from "./types/AnyGridEntity";
 export * from "./types/CollectibleIndex";
 export * from "./types/ConversionHeartSubType";
+export * from "./types/Decrement";
 export * from "./types/EntityID";
 export * from "./types/FunctionTuple";
 export * from "./types/GridEntityID";
 export * from "./types/HasFunction";
 export * from "./types/Immutable";
+export * from "./types/Increment";
 export * from "./types/LowercaseKeys";
+export * from "./types/NaturalNumbersEqualToOrLessThan";
 export * from "./types/NaturalNumbersLessThan";
 export * from "./types/PickingUpItem";
 export * from "./types/PickupIndex";
@@ -171,8 +174,10 @@ export * from "./types/ReadonlySet";
 export * from "./types/StartsWithLowercase";
 export * from "./types/StartsWithUppercase";
 export * from "./types/TSTLClass";
+export * from "./types/Tuple";
 export * from "./types/TupleToIntersection";
 export * from "./types/TupleToUnion";
+export * from "./types/TupleWithMaxLength";
 export * from "./types/UnionToIntersection";
 export * from "./types/UppercaseKeys";
 export * from "./types/WeightedArray";

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0CAA0C,CAAC;AACzD,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0CAA0C,CAAC;AACzD,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yCAAyC,CAAC;AACxD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC"}

package/dist/src/types/Decrement.d.ts

@@ -0,0 +1,8 @@
+import { Tuple } from "./Tuple";
+/**
+ * Helper type to subtract one from a number type.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export type Decrement<N extends number> = Tuple<N> extends [unknown, ...infer U] ? U["length"] : never;
+//# sourceMappingURL=Decrement.d.ts.map

package/dist/src/types/Decrement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Decrement.d.ts","sourceRoot":"","sources":["../../../src/types/Decrement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,CAAC,GAC5E,CAAC,CAAC,QAAQ,CAAC,GACX,KAAK,CAAC"}

package/dist/src/types/Decrement.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/dist/src/types/Increment.d.ts

@@ -0,0 +1,8 @@
+import { Tuple } from "./Tuple";
+/**
+ * Helper type to add one to a number type.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export type Increment<N extends number> = [...Tuple<N>, unknown]["length"];
+//# sourceMappingURL=Increment.d.ts.map

package/dist/src/types/Increment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Increment.d.ts","sourceRoot":"","sources":["../../../src/types/Increment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC"}

package/dist/src/types/Increment.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/dist/src/types/NaturalNumbersEqualToOrLessThan.d.ts

@@ -0,0 +1,10 @@
+import { Increment } from "./Increment";
+import { NaturalNumbersLessThan } from "./NaturalNumbersLessThan";
+/**
+ * Helper type to get a range of integers between 0 and N.
+ *
+ * From:
+ * https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
+ */
+export type NaturalNumbersLessThanOrEqualTo<N extends number> = NaturalNumbersLessThan<Increment<N>>;
+//# sourceMappingURL=NaturalNumbersEqualToOrLessThan.d.ts.map

package/dist/src/types/NaturalNumbersEqualToOrLessThan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NaturalNumbersEqualToOrLessThan.d.ts","sourceRoot":"","sources":["../../../src/types/NaturalNumbersEqualToOrLessThan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,CAAC,CAAC,SAAS,MAAM,IAE1D,sBAAsB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/src/types/NaturalNumbersEqualToOrLessThan.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/dist/src/types/Range.d.ts

@@ -1,10 +1,12 @@
+import { NaturalNumbersLessThanOrEqualTo } from "./NaturalNumbersEqualToOrLessThan";
 import { NaturalNumbersLessThan } from "./NaturalNumbersLessThan";
 /**
- * Helper type to get a range of integers between low and high. It is inclusive on the lower end and
- * exclusive on the higher end.
+ * Helper type to get a range of integers. It is inclusive on both ends.
+ *
+ * For example, `Range<3, 5>` will return `3 | 4 | 5`.
  *
  * From:
  * https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
  */
-export type Range<Low extends number, High extends number> = Exclude<NaturalNumbersLessThan<High>, NaturalNumbersLessThan<Low>>;
+export type Range<Low extends number, High extends number> = Exclude<NaturalNumbersLessThanOrEqualTo<High>, NaturalNumbersLessThan<Low>>;
 //# sourceMappingURL=Range.d.ts.map

package/dist/src/types/Range.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Range.d.ts","sourceRoot":"","sources":["../../../src/types/Range.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,CAAC,GAAG,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM,IAAI,OAAO,CAClE,sBAAsB,CAAC,IAAI,CAAC,EAC5B,sBAAsB,CAAC,GAAG,CAAC,CAC5B,CAAC"}
+{"version":3,"file":"Range.d.ts","sourceRoot":"","sources":["../../../src/types/Range.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AACpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,GAAG,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM,IAAI,OAAO,CAClE,+BAA+B,CAAC,IAAI,CAAC,EACrC,sBAAsB,CAAC,GAAG,CAAC,CAC5B,CAAC"}

package/dist/src/types/Tuple.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Helper type to represent a tuple of length N.
+ *
+ * This is used by the `Increment` and `Decrement` helper types.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export type Tuple<N extends number, T extends unknown[] = []> = T["length"] extends N ? T : Tuple<N, [...T, unknown]>;
+//# sourceMappingURL=Tuple.d.ts.map

package/dist/src/types/Tuple.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tuple.d.ts","sourceRoot":"","sources":["../../../src/types/Tuple.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,KAAK,CACf,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,IACtB,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC"}

package/dist/src/types/Tuple.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/dist/src/types/TupleWithMaxLength.d.ts

@@ -0,0 +1,10 @@
+import { NaturalNumbersLessThanOrEqualTo } from "./NaturalNumbersEqualToOrLessThan";
+/**
+ * Helper type that validates that a tuple does not have a length greater than N.
+ *
+ * For example, `TupleWithMaxLength<string, 3>` will allow string tuples of size 0, 1, 2, or 3.
+ */
+export type TupleWithMaxLength<T, MaxLength extends number> = (T[] | readonly T[]) & {
+    length: NaturalNumbersLessThanOrEqualTo<MaxLength>;
+};
+//# sourceMappingURL=TupleWithMaxLength.d.ts.map

package/dist/src/types/TupleWithMaxLength.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TupleWithMaxLength.d.ts","sourceRoot":"","sources":["../../../src/types/TupleWithMaxLength.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AAEpF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,EAAE,SAAS,SAAS,MAAM,IAAI,CAC1D,CAAC,EAAE,GACH,SAAS,CAAC,EAAE,CACf,GAAG;IACF,MAAM,EAAE,+BAA+B,CAAC,SAAS,CAAC,CAAC;CACpD,CAAC"}

package/dist/src/types/TupleWithMaxLength.lua

@@ -0,0 +1,2 @@
+local ____exports = {}
+return ____exports

package/package.json

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

package/src/index.ts

@@ -153,13 +153,16 @@ export * from "./types/AnyFunction";
 export * from "./types/AnyGridEntity";
 export * from "./types/CollectibleIndex";
 export * from "./types/ConversionHeartSubType";
+export * from "./types/Decrement";
 export * from "./types/EntityID";
 export * from "./types/FunctionTuple";
 export * from "./types/GridEntityID";
 export * from "./types/HasFunction";
 export * from "./types/Immutable";
+export * from "./types/Increment";
 export * from "./types/LowercaseKeys";
 export * from "./types/NaturalNumbersLessThan";
+export * from "./types/NaturalNumbersLessThanOrEqualTo";
 export * from "./types/PickingUpItem";
 export * from "./types/PickupIndex";
 export * from "./types/PlayerIndex";
@@ -171,8 +174,10 @@ export * from "./types/ReadonlySet";
 export * from "./types/StartsWithLowercase";
 export * from "./types/StartsWithUppercase";
 export * from "./types/TSTLClass";
+export * from "./types/Tuple";
 export * from "./types/TupleToIntersection";
 export * from "./types/TupleToUnion";
+export * from "./types/TupleWithMaxLength";
 export * from "./types/UnionToIntersection";
 export * from "./types/UppercaseKeys";
 export * from "./types/WeightedArray";

package/src/types/Decrement.ts

@@ -0,0 +1,10 @@
+import { Tuple } from "./Tuple";
+
+/**
+ * Helper type to subtract one from a number type.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export type Decrement<N extends number> = Tuple<N> extends [unknown, ...infer U]
+  ? U["length"]
+  : never;

package/src/types/Increment.ts

@@ -0,0 +1,8 @@
+import { Tuple } from "./Tuple";
+
+/**
+ * Helper type to add one to a number type.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export type Increment<N extends number> = [...Tuple<N>, unknown]["length"];

package/src/types/NaturalNumbersLessThanOrEqualTo.ts

@@ -0,0 +1,12 @@
+import { Increment } from "./Increment";
+import { NaturalNumbersLessThan } from "./NaturalNumbersLessThan";
+
+/**
+ * Helper type to get a range of integers between 0 and N.
+ *
+ * From:
+ * https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
+ */
+export type NaturalNumbersLessThanOrEqualTo<N extends number> =
+  // @ts-expect-error The return value of increment is a number, but TypeScript gets confused.
+  NaturalNumbersLessThan<Increment<N>>;

package/src/types/Range.ts

@@ -1,13 +1,15 @@
 import { NaturalNumbersLessThan } from "./NaturalNumbersLessThan";
+import { NaturalNumbersLessThanOrEqualTo } from "./NaturalNumbersLessThanOrEqualTo";
 
 /**
- * Helper type to get a range of integers between low and high. It is inclusive on the lower end and
- * exclusive on the higher end.
+ * Helper type to get a range of integers. It is inclusive on both ends.
+ *
+ * For example, `Range<3, 5>` will return `3 | 4 | 5`.
  *
  * From:
  * https://stackoverflow.com/questions/39494689/is-it-possible-to-restrict-number-to-a-certain-range
  */
 export type Range<Low extends number, High extends number> = Exclude<
-  NaturalNumbersLessThan<High>,
+  NaturalNumbersLessThanOrEqualTo<High>,
   NaturalNumbersLessThan<Low>
 >;

package/src/types/Tuple.ts

@@ -0,0 +1,11 @@
+/**
+ * Helper type to represent a tuple of length N.
+ *
+ * This is used by the `Increment` and `Decrement` helper types.
+ *
+ * From: https://stackoverflow.com/questions/54243431/typescript-increment-number-type
+ */
+export type Tuple<
+  N extends number,
+  T extends unknown[] = [],
+> = T["length"] extends N ? T : Tuple<N, [...T, unknown]>;

package/src/types/TupleWithMaxLength.ts

@@ -0,0 +1,13 @@
+import { NaturalNumbersLessThanOrEqualTo } from "./NaturalNumbersLessThanOrEqualTo";
+
+/**
+ * Helper type that validates that a tuple does not have a length greater than N.
+ *
+ * For example, `TupleWithMaxLength<string, 3>` will allow string tuples of size 0, 1, 2, or 3.
+ */
+export type TupleWithMaxLength<T, MaxLength extends number> = (
+  | T[]
+  | readonly T[]
+) & {
+  length: NaturalNumbersLessThanOrEqualTo<MaxLength>;
+};