isaacscript-common 30.2.0 → 30.4.0

package/dist/index.rollup.d.ts

@@ -8303,6 +8303,15 @@ export declare function isRoomInsideGrid(roomGridIndex?: int): boolean;
  */
 export declare function isRoomShapeDoubleCharge(roomShape: RoomShape): boolean;
 
+/**
+ * Helper function to check if a given room is visible on the minimap.
+ *
+ * @param roomGridIndex The room to check.
+ * @param minimapAPI Optional. Whether or not MinimapAPI should be used, if present. Default is
+ *                   true.
+ */
+export declare function isRoomVisible(roomGridIndex: int, minimapAPI?: boolean): boolean;
+
 /** Returns true for cards that have `CardType.RUNE`. */
 export declare function isRune(cardType: CardType): boolean;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 30.2.0
+isaacscript-common 30.4.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -53300,6 +53300,13 @@ function ____exports.hideRoomOnMinimap(self, roomGridIndex)
         minimapAPIRoomDescriptor.Hidden = true
     end
 end
+function ____exports.isRoomVisible(self, roomGridIndex, minimapAPI)
+    if minimapAPI == nil then
+        minimapAPI = true
+    end
+    local roomDisplayFlags = ____exports.getRoomDisplayFlags(nil, roomGridIndex, minimapAPI)
+    return roomDisplayFlags ~= DisplayFlagZero
+end
 function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
     for ____, ____value in __TS__Iterator(displayFlagsMap) do
         local roomGridIndex = ____value[1]

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

@@ -64,6 +64,14 @@ export declare function getRoomDisplayFlags(roomGridIndex?: int, minimapAPI?: bo
  * This function automatically accounts for whether or not MinimapAPI is being used.
  */
 export declare function hideRoomOnMinimap(roomGridIndex: int): void;
+/**
+ * Helper function to check if a given room is visible on the minimap.
+ *
+ * @param roomGridIndex The room to check.
+ * @param minimapAPI Optional. Whether or not MinimapAPI should be used, if present. Default is
+ *                   true.
+ */
+export declare function isRoomVisible(roomGridIndex: int, minimapAPI?: boolean): boolean;
 /**
  * Helper function to set the minimap `DisplayFlag` value for every room on the floor at once.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"minimap.d.ts","sourceRoot":"","sources":["../../../src/functions/minimap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,8BAA8B,CAAC;AAM5E;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,WAAW,EAAE,WAAW,EACxB,gBAAgB,UAAO,GACtB,IAAI,CAIN;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAE7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAE9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,UAAO,GAChB,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAUjC;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,EACnB,UAAU,UAAO,GAChB,QAAQ,CAAC,WAAW,CAAC,CAiBvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAe1D;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAW5E;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAWN;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,EACnC,gBAAgB,UAAO,GACtB,IAAI,CAsBN"}
+{"version":3,"file":"minimap.d.ts","sourceRoot":"","sources":["../../../src/functions/minimap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,8BAA8B,CAAC;AAM5E;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,WAAW,EAAE,WAAW,EACxB,gBAAgB,UAAO,GACtB,IAAI,CAIN;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAE7C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAE9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,UAAO,GAChB,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAUjC;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,EACnB,UAAU,UAAO,GAChB,QAAQ,CAAC,WAAW,CAAC,CAiBvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAe1D;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,GAAG,EAAE,UAAU,UAAO,GAAG,OAAO,CAG5E;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAW5E;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAWN;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,EACnC,gBAAgB,UAAO,GACtB,IAAI,CAsBN"}

package/dist/src/functions/minimap.lua

@@ -162,6 +162,18 @@ function ____exports.hideRoomOnMinimap(self, roomGridIndex)
         minimapAPIRoomDescriptor.Hidden = true
     end
 end
+--- Helper function to check if a given room is visible on the minimap.
+-- 
+-- @param roomGridIndex The room to check.
+-- @param minimapAPI Optional. Whether or not MinimapAPI should be used, if present. Default is
+-- true.
+function ____exports.isRoomVisible(self, roomGridIndex, minimapAPI)
+    if minimapAPI == nil then
+        minimapAPI = true
+    end
+    local roomDisplayFlags = ____exports.getRoomDisplayFlags(nil, roomGridIndex, minimapAPI)
+    return roomDisplayFlags ~= DisplayFlagZero
+end
 --- Helper function to set the minimap `DisplayFlag` value for multiple rooms at once.
 -- 
 -- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that

package/package.json

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

package/src/functions/minimap.ts

@@ -134,6 +134,18 @@ export function hideRoomOnMinimap(roomGridIndex: int): void {
   }
 }
 
+/**
+ * Helper function to check if a given room is visible on the minimap.
+ *
+ * @param roomGridIndex The room to check.
+ * @param minimapAPI Optional. Whether or not MinimapAPI should be used, if present. Default is
+ *                   true.
+ */
+export function isRoomVisible(roomGridIndex: int, minimapAPI = true): boolean {
+  const roomDisplayFlags = getRoomDisplayFlags(roomGridIndex, minimapAPI);
+  return roomDisplayFlags !== DisplayFlagZero;
+}
+
 /**
  * Helper function to set the minimap `DisplayFlag` value for every room on the floor at once.
  *