isaacscript-common 72.9.0 → 72.9.1

package/dist/index.rollup.d.ts

@@ -7312,12 +7312,16 @@ export declare function getRoomListIndex(roomGridIndex?: int): int;
  *
  * (The version of the function without any arguments will not return undefined since the current
  * room is guaranteed to have data.)
+ *
+ * If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
  */
 export declare function getRoomName(): string;
 
 /**
  * Helper function to get the name of the room as it appears in the STB/XML data.
  *
+ * If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
+ *
  * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room name. Returns undefined if the room data was not found.
  */

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 72.9.0
+isaacscript-common 72.9.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -27336,8 +27336,8 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 ____exports.ROOM_TYPE_NAMES = {
-    [RoomType.DEFAULT] = "default room",
-    [RoomType.SHOP] = "shop",
+    [RoomType.DEFAULT] = "Default Room",
+    [RoomType.SHOP] = "Shop",
     [RoomType.ERROR] = "I AM ERROR Room",
     [RoomType.TREASURE] = "Treasure Room",
     [RoomType.BOSS] = "Boss Room",

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

@@ -70,11 +70,15 @@ export declare function getRoomListIndex(roomGridIndex?: int): int;
  *
  * (The version of the function without any arguments will not return undefined since the current
  * room is guaranteed to have data.)
+ *
+ * If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
  */
 export declare function getRoomName(): string;
 /**
  * Helper function to get the name of the room as it appears in the STB/XML data.
  *
+ * If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
+ *
  * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room name. Returns undefined if the room data was not found.
  */

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;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,UAAU,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAAC;AAOzE;;;;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;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,MAAM,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAAC;AAOrE;;;;;;;;GAQG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAAC;AAOzE;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC;AAE1C;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,GAAG,SAAS,CAAC;AAOzE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAOrE;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,GAAG,SAAS,CAAC;AAavE;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC;AAEtC;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAOrE;;;;;;;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;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,UAAU,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,GAAG,SAAS,CAAC;AAOzE;;;;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;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,IAAI,MAAM,CAAC;AAEtC;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAAC;AAOrE;;;;;;;;GAQG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,SAAS,GAAG,SAAS,CAAC;AAOzE;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC;AAE1C;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,OAAO,GAAG,SAAS,CAAC;AAOzE;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAOrE;;;;;;;;GAQG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,QAAQ,GAAG,SAAS,CAAC;AAavE;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,IAAI,GAAG,CAAC;AAEtC;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,aAAa,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC;AAOrE;;;;;;;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

@@ -101,8 +101,12 @@ end
 -- 
 -- (The version of the function without any arguments will not return undefined since the current
 -- room is guaranteed to have data.)
+-- 
+-- If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
 -- Helper function to get the name of the room as it appears in the STB/XML data.
 -- 
+-- If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
+-- 
 -- @param roomGridIndex Optional. Default is the current room index.
 -- @returns The room name. Returns undefined if the room data was not found.
 function ____exports.getRoomName(self, roomGridIndex)

package/dist/src/objects/roomTypeNames.d.ts

@@ -1,6 +1,6 @@
 export declare const ROOM_TYPE_NAMES: {
-    readonly 1: "default room";
-    readonly 2: "shop";
+    readonly 1: "Default Room";
+    readonly 2: "Shop";
     readonly 3: "I AM ERROR Room";
     readonly 4: "Treasure Room";
     readonly 5: "Boss Room";

package/dist/src/objects/roomTypeNames.lua

@@ -2,8 +2,8 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 ____exports.ROOM_TYPE_NAMES = {
-    [RoomType.DEFAULT] = "default room",
-    [RoomType.SHOP] = "shop",
+    [RoomType.DEFAULT] = "Default Room",
+    [RoomType.SHOP] = "Shop",
     [RoomType.ERROR] = "I AM ERROR Room",
     [RoomType.TREASURE] = "Treasure Room",
     [RoomType.BOSS] = "Boss Room",

package/package.json

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

package/src/functions/roomData.ts

@@ -132,12 +132,16 @@ export function getRoomListIndex(roomGridIndex?: int): int {
  *
  * (The version of the function without any arguments will not return undefined since the current
  * room is guaranteed to have data.)
+ *
+ * If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
  */
 export function getRoomName(): string;
 
 /**
  * Helper function to get the name of the room as it appears in the STB/XML data.
  *
+ * If you want to get the room name for a specific room type, use the `getRoomTypeName` function.
+ *
  * @param roomGridIndex Optional. Default is the current room index.
  * @returns The room name. Returns undefined if the room data was not found.
  */

package/src/objects/roomTypeNames.ts

@@ -1,8 +1,8 @@
 import { RoomType } from "isaac-typescript-definitions";
 
 export const ROOM_TYPE_NAMES = {
-  [RoomType.DEFAULT]: "default room", // 1
-  [RoomType.SHOP]: "shop", // 2
+  [RoomType.DEFAULT]: "Default Room", // 1
+  [RoomType.SHOP]: "Shop", // 2
   [RoomType.ERROR]: "I AM ERROR Room", // 3
   [RoomType.TREASURE]: "Treasure Room", // 4
   [RoomType.BOSS]: "Boss Room", // 5