isaacscript-common 34.0.0 → 34.1.1

package/dist/index.rollup.d.ts

@@ -5581,6 +5581,8 @@ export declare function getHighestArrayElement(array: number[]): number | undefi
  *
  * Note that this is not necessarily the enum value that is declared last in the code, since there
  * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
  */
 export declare function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T];
 
@@ -5745,6 +5747,16 @@ export declare function getLevelBossIDs(): BossID[];
  */
 export declare function getLowestArrayElement(array: number[]): number | undefined;
 
+/**
+ * Helper function to get the enum value with the lowest value.
+ *
+ * Note that this is not necessarily the enum value that is declared first in the code, since there
+ * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
+ */
+export declare function getLowestEnumValue<T>(transpiledEnum: T): T[keyof T];
+
 /**
  * Helper function to get the closest value from a map based on partial search text. For the
  * purposes of this function, both search text and map keys are converted to lowercase before
@@ -6706,12 +6718,15 @@ export declare function getRoomDescriptorsForType(...roomTypes: RoomType[]): Roo
 export declare function getRoomDisplayFlags(roomGridIndex?: int, minimapAPI?: boolean): BitFlags<DisplayFlag>;
 
 /**
- * Helper function to get the safe grid index of the current room. (The safe grid index is defined
- * as the top-left 1x1 section that the room overlaps with, or the top-right 1x1 section of a
- * `RoomType.SHAPE_LTL` room.)
+ * Helper function to get the grid index of the current room.
  *
- * Under the hood, this function uses the `Level.GetCurrentRoomDesc` method. (In Afterbirth+, this
- * method was bugged for rooms outside of the grid, but it is now fixed.)
+ * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+ *   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
+ *   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
+ * - If the current room is outside of the grid, it will return the index from the
+ *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases, as
+ *   demonstrated by entering a Genesis room and entering `l
+ *   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console).
  *
  * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
  * will return the specific 1x1 quadrant that the player entered the room at. For most situations,
@@ -8444,7 +8459,7 @@ export declare function isEntity(variable: unknown): variable is Entity;
 export declare function isEntityMoving(entity: Entity, threshold?: number): boolean;
 
 /** Helper function to validate that a particular value exists inside of an enum. */
-export declare function isEnumValue(value: number | string, transpiledEnum: Record<string | number, string | number>): boolean;
+export declare function isEnumValue<T extends Record<string, number | string>>(value: number | string, transpiledEnum: T): value is T[keyof T];
 
 export declare function isEven(num: int): boolean;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 34.0.0
+isaacscript-common 34.1.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -17221,6 +17221,7 @@ return ____exports
 local ____lualib = require("lualib_bundle")
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayAt = ____lualib.__TS__ArrayAt
 local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
@@ -17287,10 +17288,16 @@ function ____exports.getEnumValues(self, transpiledEnum)
 end
 function ____exports.getHighestEnumValue(self, transpiledEnum)
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastElement = enumValues[#enumValues]
+    local lastElement = __TS__ArrayAt(enumValues, -1)
     assertDefined(nil, lastElement, "Failed to get the last value from an enum since the enum was empty.")
     return lastElement
 end
+function ____exports.getLowestEnumValue(self, transpiledEnum)
+    local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
+    local firstElement = enumValues[1]
+    assertDefined(nil, firstElement, "Failed to get the first value from an enum since the enum was empty.")
+    return firstElement
+end
 function ____exports.getRandomEnumValue(self, transpiledEnum, seedOrRNG, exceptions)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
@@ -17316,7 +17323,7 @@ function ____exports.validateCustomEnum(self, transpiledEnumName, transpiledEnum
 end
 function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiledEnum)
     local values = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastValue = values[#values]
+    local lastValue = __TS__ArrayAt(values, -1)
     assertDefined(nil, lastValue, "Failed to validate that an enum was contiguous, since the last value was undefined.")
     if not isNumber(nil, lastValue) then
         error("Failed to validate that an enum was contiguous, since the last value was not a number.")
@@ -26783,6 +26790,11 @@ function ____exports.getRoomDescriptorReadOnly(self)
     return level:GetCurrentRoomDesc()
 end
 function ____exports.getRoomGridIndex(self)
+    local level = game:GetLevel()
+    local currentRoomIndex = level:GetCurrentRoomIndex()
+    if currentRoomIndex < 0 then
+        return currentRoomIndex
+    end
     local roomDescriptor = ____exports.getRoomDescriptorReadOnly(nil)
     return roomDescriptor.SafeGridIndex
 end
@@ -34680,7 +34692,7 @@ function RoomHistory.prototype.getRoomHistory(self)
 end
 __TS__DecorateLegacy({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 function RoomHistory.prototype.getPreviousRoomDescription(self)
-    local previousRoomDescription = v.run.roomHistory[#v.run.roomHistory - 2 + 1]
+    local previousRoomDescription = __TS__ArrayAt(v.run.roomHistory, -2)
     if previousRoomDescription ~= nil then
         return previousRoomDescription
     end
@@ -46718,12 +46730,11 @@ function getJSONObjectWithChosenWeight(self, jsonOjectArray, chosenWeight)
 end
 function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
     local roomShapeString = jsonRoom["$"].shape
-    local roomShapeNumber = tonumber(roomShapeString)
-    assertDefined(nil, roomShapeNumber, "Failed to parse the \"shape\" field of a JSON room: " .. roomShapeString)
-    if not isEnumValue(nil, roomShapeNumber, RoomShape) then
-        error("Failed to parse the \"shape\" field of a JSON room since it was an invalid number: " .. tostring(roomShapeNumber))
+    local roomShape = tonumber(roomShapeString)
+    assertDefined(nil, roomShape, "Failed to parse the \"shape\" field of a JSON room: " .. roomShapeString)
+    if not isEnumValue(nil, roomShape, RoomShape) then
+        error("Failed to parse the \"shape\" field of a JSON room since it was an invalid number: " .. tostring(roomShape))
     end
-    local roomShape = roomShapeNumber
     local doorSlotFlags = DoorSlotFlagZero
     for ____, door in ipairs(jsonRoom.door) do
         do

package/dist/src/classes/features/other/RoomHistory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":";AAaA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,WAAY,SAAQ,OAAO;IActC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAgC/B;IAEF;;;;OAIG;IAEI,yBAAyB,IAAI,IAAI;IAIxC;;;;;OAKG;IAEI,kBAAkB,IAAI,GAAG;IAIhC;;;;;OAKG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;;;OAOG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAiB9D;;;;;;;;;;OAUG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE,gFAAgF;IAEzE,WAAW,IAAI,OAAO;IAI7B;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAwBhC"}
+{"version":3,"file":"RoomHistory.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RoomHistory.ts"],"names":[],"mappings":";AAaA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAQhD,qBAAa,WAAY,SAAQ,OAAO;IActC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAgC/B;IAEF;;;;OAIG;IAEI,yBAAyB,IAAI,IAAI;IAIxC;;;;;OAKG;IAEI,kBAAkB,IAAI,GAAG;IAIhC;;;;;OAKG;IAEI,cAAc,IAAI,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAIjE;;;;;;;OAOG;IAEI,0BAA0B,IAAI,QAAQ,CAAC,eAAe,CAAC;IAgB9D;;;;;;;;;;OAUG;IAEI,wBAAwB,IAAI,QAAQ,CAAC,eAAe,CAAC,GAAG,SAAS;IAIxE,gFAAgF;IAEzE,WAAW,IAAI,OAAO;IAI7B;;;;;;;;;;OAUG;IAEI,aAAa,IAAI,OAAO;CAwBhC"}

package/dist/src/classes/features/other/RoomHistory.lua

@@ -78,7 +78,7 @@ function RoomHistory.prototype.getRoomHistory(self)
 end
 __TS__DecorateLegacy({Exported}, RoomHistory.prototype, "getRoomHistory", true)
 function RoomHistory.prototype.getPreviousRoomDescription(self)
-    local previousRoomDescription = v.run.roomHistory[#v.run.roomHistory - 2 + 1]
+    local previousRoomDescription = __TS__ArrayAt(v.run.roomHistory, -2)
     if previousRoomDescription ~= nil then
         return previousRoomDescription
     end

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

@@ -60,8 +60,19 @@ export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
  *
  * Note that this is not necessarily the enum value that is declared last in the code, since there
  * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
  */
 export declare function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T];
+/**
+ * Helper function to get the enum value with the lowest value.
+ *
+ * Note that this is not necessarily the enum value that is declared first in the code, since there
+ * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
+ */
+export declare function getLowestEnumValue<T>(transpiledEnum: T): T[keyof T];
 /**
  * Helper function to get a random value from the provided enum.
  *
@@ -72,7 +83,7 @@ export declare function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T];
  */
 export declare function getRandomEnumValue<T>(transpiledEnum: T, seedOrRNG?: Seed | RNG, exceptions?: Array<T[keyof T]> | ReadonlyArray<T[keyof T]>): T[keyof T];
 /** Helper function to validate that a particular value exists inside of an enum. */
-export declare function isEnumValue(value: number | string, transpiledEnum: Record<string | number, string | number>): boolean;
+export declare function isEnumValue<T extends Record<string, number | string>>(value: number | string, transpiledEnum: T): value is T[keyof T];
 /**
  * Helper function to check every value of a custom enum for -1. Will throw an run-time error if any
  * -1 values are found. This is helpful because many methods of the Isaac class return -1 if they

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

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CACzB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,MAAM,EAAE,CAGV;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,GAAG,CAGL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUpE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED,oFAAoF;AACpF,wBAAgB,WAAW,CACzB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,OAAO,CAGT;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN;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":"enums.d.ts","sourceRoot":"","sources":["../../../src/functions/enums.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,cAAc,EAAE,CAAC,GAChB,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAmBzC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CACzB,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,MAAM,EAAE,CAGV;AAED,sEAAsE;AACtE,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACvD,GAAG,CAGL;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAGrE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUpE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAUnE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,cAAc,EAAE,CAAC,EACjB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,GAC7D,CAAC,CAAC,MAAM,CAAC,CAAC,CAGZ;AAED,oFAAoF;AACpF,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EACnE,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,cAAc,EAAE,CAAC,GAChB,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAGrB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,OAAO,GACtB,IAAI,CAQN;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACtC,kBAAkB,EAAE,MAAM,EAC1B,cAAc,EAAE,CAAC,GAChB,IAAI,CAsBN;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/enums.lua

@@ -1,6 +1,7 @@
 local ____lualib = require("lualib_bundle")
 local __TS__ArraySort = ____lualib.__TS__ArraySort
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArrayAt = ____lualib.__TS__ArrayAt
 local __TS__ArrayIncludes = ____lualib.__TS__ArrayIncludes
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
@@ -113,12 +114,26 @@ end
 -- 
 -- Note that this is not necessarily the enum value that is declared last in the code, since there
 -- is no way to infer that at run-time.
+-- 
+-- Throws an error if the provided enum is empty.
 function ____exports.getHighestEnumValue(self, transpiledEnum)
     local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastElement = enumValues[#enumValues]
+    local lastElement = __TS__ArrayAt(enumValues, -1)
     assertDefined(nil, lastElement, "Failed to get the last value from an enum since the enum was empty.")
     return lastElement
 end
+--- Helper function to get the enum value with the lowest value.
+-- 
+-- Note that this is not necessarily the enum value that is declared first in the code, since there
+-- is no way to infer that at run-time.
+-- 
+-- Throws an error if the provided enum is empty.
+function ____exports.getLowestEnumValue(self, transpiledEnum)
+    local enumValues = ____exports.getEnumValues(nil, transpiledEnum)
+    local firstElement = enumValues[1]
+    assertDefined(nil, firstElement, "Failed to get the first value from an enum since the enum was empty.")
+    return firstElement
+end
 --- Helper function to get a random value from the provided enum.
 -- 
 -- @param transpiledEnum The enum to get the value from.
@@ -167,7 +182,7 @@ end
 -- This is useful to automate checking large enums for typos.
 function ____exports.validateEnumContiguous(self, transpiledEnumName, transpiledEnum)
     local values = ____exports.getEnumValues(nil, transpiledEnum)
-    local lastValue = values[#values]
+    local lastValue = __TS__ArrayAt(values, -1)
     assertDefined(nil, lastValue, "Failed to validate that an enum was contiguous, since the last value was undefined.")
     if not isNumber(nil, lastValue) then
         error("Failed to validate that an enum was contiguous, since the last value was not a number.")

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

@@ -1 +1 @@
-{"version":3,"file":"jsonRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/jsonRoom.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAexE;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,YAAY,CAAC,CAsDxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,GAAG,SAAS,CAoBtB;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,EAAE,CAMZ;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,UAAU,EAAE,EAC1B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,UAAU,CAqBZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,QAAQ,CAkBV"}
+{"version":3,"file":"jsonRoom.d.ts","sourceRoot":"","sources":["../../../src/functions/jsonRoom.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAexE;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,QAAQ,GACjB,QAAQ,CAAC,YAAY,CAAC,CAqDxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,GAAG,SAAS,CAoBtB;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,QAAQ,EAAE,GAAG,SAAS,QAAQ,EAAE,EAC3C,OAAO,EAAE,GAAG,GACX,QAAQ,EAAE,CAMZ;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CACjC,YAAY,EAAE,UAAU,EAAE,EAC1B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,UAAU,CAqBZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,QAAQ,EAAE,EACrB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,GACd,QAAQ,CAkBV"}

package/dist/src/functions/jsonRoom.lua

@@ -62,12 +62,11 @@ end
 -- (A JSON room is an XML file converted to JSON so that it can be directly imported into your mod.)
 function ____exports.getJSONRoomDoorSlotFlags(self, jsonRoom)
     local roomShapeString = jsonRoom["$"].shape
-    local roomShapeNumber = tonumber(roomShapeString)
-    assertDefined(nil, roomShapeNumber, "Failed to parse the \"shape\" field of a JSON room: " .. roomShapeString)
-    if not isEnumValue(nil, roomShapeNumber, RoomShape) then
-        error("Failed to parse the \"shape\" field of a JSON room since it was an invalid number: " .. tostring(roomShapeNumber))
+    local roomShape = tonumber(roomShapeString)
+    assertDefined(nil, roomShape, "Failed to parse the \"shape\" field of a JSON room: " .. roomShapeString)
+    if not isEnumValue(nil, roomShape, RoomShape) then
+        error("Failed to parse the \"shape\" field of a JSON room since it was an invalid number: " .. tostring(roomShape))
     end
-    local roomShape = roomShapeNumber
     local doorSlotFlags = DoorSlotFlagZero
     for ____, door in ipairs(jsonRoom.door) do
         do

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

@@ -18,12 +18,15 @@ export declare function getRoomDescriptor(roomGridIndex?: int): RoomDescriptor;
  */
 export declare function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor>;
 /**
- * Helper function to get the safe grid index of the current room. (The safe grid index is defined
- * as the top-left 1x1 section that the room overlaps with, or the top-right 1x1 section of a
- * `RoomType.SHAPE_LTL` room.)
+ * Helper function to get the grid index of the current room.
  *
- * Under the hood, this function uses the `Level.GetCurrentRoomDesc` method. (In Afterbirth+, this
- * method was bugged for rooms outside of the grid, but it is now fixed.)
+ * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+ *   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
+ *   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
+ * - If the current room is outside of the grid, it will return the index from the
+ *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases, as
+ *   demonstrated by entering a Genesis room and entering `l
+ *   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console).
  *
  * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
  * will return the specific 1x1 quadrant that the player entered the room at. For most situations,

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

@@ -1 +1 @@
-{"version":3,"file":"roomData.d.ts","sourceRoot":"","sources":["../../../src/functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAMtC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,CAgBtE;AAGD,wBAAgB,WAAW,IAAI,UAAU,CAAC;AAC1C,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAAC;AAYzE;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAQrE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,QAAQ,CAAC,cAAc,CAAC,CAGpE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAGtC;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAGvE;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,CAGhE;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAC,CAG9D;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAG5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,aAAa,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,GAAG,IAAI,CAG1E"}
+{"version":3,"file":"roomData.d.ts","sourceRoot":"","sources":["../../../src/functions/roomData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,OAAO,EACR,MAAM,8BAA8B,CAAC;AAMtC;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,CAgBtE;AAGD,wBAAgB,WAAW,IAAI,UAAU,CAAC;AAC1C,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAAC;AAYzE;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,cAAc,CAQrE;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,QAAQ,CAAC,cAAc,CAAC,CAGpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAUtC;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGzD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAGvE;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,CAGhE;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAC,CAG9D;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAGvD;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,CAG5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,aAAa,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,GAAG,IAAI,CAG1E"}

package/dist/src/functions/roomData.lua

@@ -33,12 +33,15 @@ function ____exports.getRoomDescriptorReadOnly(self)
     local level = game:GetLevel()
     return level:GetCurrentRoomDesc()
 end
---- Helper function to get the safe grid index of the current room. (The safe grid index is defined
--- as the top-left 1x1 section that the room overlaps with, or the top-right 1x1 section of a
--- `RoomType.SHAPE_LTL` room.)
+--- Helper function to get the grid index of the current room.
 -- 
--- Under the hood, this function uses the `Level.GetCurrentRoomDesc` method. (In Afterbirth+, this
--- method was bugged for rooms outside of the grid, but it is now fixed.)
+-- - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+--   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
+--   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
+-- - If the current room is outside of the grid, it will return the index from the
+--   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases, as
+--   demonstrated by entering a Genesis room and entering `l
+--   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console).
 -- 
 -- Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
 -- will return the specific 1x1 quadrant that the player entered the room at. For most situations,
@@ -47,6 +50,11 @@ end
 -- Data structures that store data per room should use the room's `ListIndex` instead of
 -- `SafeGridIndex`, since the former is unique across different dimensions.
 function ____exports.getRoomGridIndex(self)
+    local level = game:GetLevel()
+    local currentRoomIndex = level:GetCurrentRoomIndex()
+    if currentRoomIndex < 0 then
+        return currentRoomIndex
+    end
     local roomDescriptor = ____exports.getRoomDescriptorReadOnly(nil)
     return roomDescriptor.SafeGridIndex
 end

package/package.json

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

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

@@ -110,8 +110,7 @@ export class RoomHistory extends Feature {
    */
   @Exported
   public getPreviousRoomDescription(): Readonly<RoomDescription> {
-    const previousRoomDescription =
-      v.run.roomHistory[v.run.roomHistory.length - 2];
+    const previousRoomDescription = v.run.roomHistory.at(-2);
     if (previousRoomDescription !== undefined) {
       return previousRoomDescription;
     }

package/src/functions/enums.ts

@@ -101,11 +101,13 @@ export function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]> {
  *
  * Note that this is not necessarily the enum value that is declared last in the code, since there
  * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
  */
 export function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T] {
   const enumValues = getEnumValues(transpiledEnum);
 
-  const lastElement = enumValues[enumValues.length - 1];
+  const lastElement = enumValues.at(-1);
   assertDefined(
     lastElement,
     "Failed to get the last value from an enum since the enum was empty.",
@@ -114,6 +116,26 @@ export function getHighestEnumValue<T>(transpiledEnum: T): T[keyof T] {
   return lastElement;
 }
 
+/**
+ * Helper function to get the enum value with the lowest value.
+ *
+ * Note that this is not necessarily the enum value that is declared first in the code, since there
+ * is no way to infer that at run-time.
+ *
+ * Throws an error if the provided enum is empty.
+ */
+export function getLowestEnumValue<T>(transpiledEnum: T): T[keyof T] {
+  const enumValues = getEnumValues(transpiledEnum);
+
+  const firstElement = enumValues[0];
+  assertDefined(
+    firstElement,
+    "Failed to get the first value from an enum since the enum was empty.",
+  );
+
+  return firstElement;
+}
+
 /**
  * Helper function to get a random value from the provided enum.
  *
@@ -132,12 +154,12 @@ export function getRandomEnumValue<T>(
 }
 
 /** Helper function to validate that a particular value exists inside of an enum. */
-export function isEnumValue(
+export function isEnumValue<T extends Record<string, number | string>>(
   value: number | string,
-  transpiledEnum: Record<string | number, string | number>,
-): boolean {
+  transpiledEnum: T,
+): value is T[keyof T] {
   const enumValues = getEnumValues(transpiledEnum);
-  return enumValues.includes(value);
+  return enumValues.includes(value as T[keyof T]);
 }
 
 /**
@@ -178,7 +200,7 @@ export function validateEnumContiguous<T>(
   transpiledEnum: T,
 ): void {
   const values = getEnumValues(transpiledEnum);
-  const lastValue = values[values.length - 1];
+  const lastValue = values.at(-1);
   assertDefined(
     lastValue,
     "Failed to validate that an enum was contiguous, since the last value was undefined.",

package/src/functions/jsonRoom.ts

@@ -25,18 +25,17 @@ export function getJSONRoomDoorSlotFlags(
   jsonRoom: JSONRoom,
 ): BitFlags<DoorSlotFlag> {
   const roomShapeString = jsonRoom.$.shape;
-  const roomShapeNumber = tonumber(roomShapeString);
+  const roomShape = tonumber(roomShapeString);
   assertDefined(
-    roomShapeNumber,
+    roomShape,
     `Failed to parse the "shape" field of a JSON room: ${roomShapeString}`,
   );
 
-  if (!isEnumValue(roomShapeNumber, RoomShape)) {
+  if (!isEnumValue(roomShape, RoomShape)) {
     error(
-      `Failed to parse the "shape" field of a JSON room since it was an invalid number: ${roomShapeNumber}`,
+      `Failed to parse the "shape" field of a JSON room since it was an invalid number: ${roomShape}`,
     );
   }
-  const roomShape = roomShapeNumber as RoomShape;
 
   let doorSlotFlags = DoorSlotFlagZero;
 

package/src/functions/roomData.ts

@@ -70,12 +70,15 @@ export function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor> {
 }
 
 /**
- * Helper function to get the safe grid index of the current room. (The safe grid index is defined
- * as the top-left 1x1 section that the room overlaps with, or the top-right 1x1 section of a
- * `RoomType.SHAPE_LTL` room.)
+ * Helper function to get the grid index of the current room.
  *
- * Under the hood, this function uses the `Level.GetCurrentRoomDesc` method. (In Afterbirth+, this
- * method was bugged for rooms outside of the grid, but it is now fixed.)
+ * - If the current room is inside of the grid, this function will return the `SafeGridIndex` from
+ *   the room descriptor. (The safe grid index is defined as the top-left 1x1 section that the room
+ *   overlaps with, or the top-right 1x1 section of a `RoomType.SHAPE_LTL` room.)
+ * - If the current room is outside of the grid, it will return the index from the
+ *   `Level.GetCurrentRoomIndex` method (since `SafeGridIndex` is bugged for these cases, as
+ *   demonstrated by entering a Genesis room and entering `l
+ *   print(Game():GetLevel():GetCurrentRoomDesc().SafeGridIndex)` into the console).
  *
  * Use this function instead of the `Level.GetCurrentRoomIndex` method directly because the latter
  * will return the specific 1x1 quadrant that the player entered the room at. For most situations,
@@ -85,6 +88,13 @@ export function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor> {
  * `SafeGridIndex`, since the former is unique across different dimensions.
  */
 export function getRoomGridIndex(): int {
+  const level = game.GetLevel();
+  const currentRoomIndex = level.GetCurrentRoomIndex();
+
+  if (currentRoomIndex < 0) {
+    return currentRoomIndex;
+  }
+
   const roomDescriptor = getRoomDescriptorReadOnly();
   return roomDescriptor.SafeGridIndex;
 }