isaacscript-common 27.6.3 → 27.7.0

package/dist/index.rollup.d.ts

@@ -1315,6 +1315,10 @@ export declare function clearFloorDisplayFlags(): void;
  *
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
  * the changes will be immediately visible.
+ *
+ * Note that if you clear the display flags of a room but then the player travels to the room (or an
+ * adjacent room), the room will appear on the minimap again. If you want to permanently hide the
+ * room even in this circumstance, use the `hideRoomOnMinimap` helper function instead.
  */
 export declare function clearRoomDisplayFlags(roomGridIndex: int): void;
 
@@ -7097,6 +7101,17 @@ export declare function hexToColor(hexString: string, alpha?: number): Readonly<
  */
 export declare function hexToKColor(hexString: string, alpha?: number): Readonly<KColor>;
 
+/**
+ * Helper function to hide a specific room on the minimap.
+ *
+ * If you want the room to be permanently hidden, you must to call this function on every new room.
+ * This is because if the player enters into the room or walks into an adjacent room, the room will
+ * reappear on the minimap.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ */
+export declare function hideRoomOnMinimap(roomGridIndex: int): void;
+
 /**
  * Helper type to make the given array/map/set/object recursively read-only.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 27.6.3
+isaacscript-common 27.7.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -51921,13 +51921,9 @@ function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags, upda
     else
         local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
         if minimapAPIRoomDescriptor == nil then
-            if displayFlags == DisplayFlagZero then
-                return
-            end
             error("Failed to get the MinimapAPI room descriptor for the room at grid index: " .. tostring(roomGridIndex))
         end
         minimapAPIRoomDescriptor:SetDisplayFlags(displayFlags)
-        minimapAPIRoomDescriptor.Hidden = displayFlags == DisplayFlagZero
     end
 end
 function ____exports.addRoomDisplayFlag(self, roomGridIndex, displayFlag, updateVisibility)
@@ -51953,6 +51949,16 @@ function ____exports.getFloorDisplayFlags(self)
     end
     return displayFlagsMap
 end
+function ____exports.hideRoomOnMinimap(self, roomGridIndex)
+    ____exports.clearRoomDisplayFlags(nil, roomGridIndex)
+    if MinimapAPI ~= nil then
+        local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+        if minimapAPIRoomDescriptor == nil then
+            error("Failed to get the MinimapAPI room descriptor for the room at grid index: " .. tostring(roomGridIndex))
+        end
+        minimapAPIRoomDescriptor.Hidden = true
+    end
+end
 function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
     for ____, ____value in __TS__Iterator(displayFlagsMap) do
         local roomGridIndex = ____value[1]

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

@@ -27,6 +27,10 @@ export declare function clearFloorDisplayFlags(): void;
  *
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
  * the changes will be immediately visible.
+ *
+ * Note that if you clear the display flags of a room but then the player travels to the room (or an
+ * adjacent room), the room will appear on the minimap again. If you want to permanently hide the
+ * room even in this circumstance, use the `hideRoomOnMinimap` helper function instead.
  */
 export declare function clearRoomDisplayFlags(roomGridIndex: int): void;
 /**
@@ -45,6 +49,16 @@ export declare function getFloorDisplayFlags(): Map<int, BitFlags<DisplayFlag>>;
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomDisplayFlags(roomGridIndex?: int): BitFlags<DisplayFlag>;
+/**
+ * Helper function to hide a specific room on the minimap.
+ *
+ * If you want the room to be permanently hidden, you must to call this function on every new room.
+ * This is because if the player enters into the room or walks into an adjacent room, the room will
+ * reappear on the minimap.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ */
+export declare function hideRoomOnMinimap(roomGridIndex: int): void;
 /**
  * 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;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,CAE9D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAUtE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,GAClB,QAAQ,CAAC,WAAW,CAAC,CAiBvB;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,CA4BN"}
+{"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;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAUtE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,GAClB,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"}

package/dist/src/functions/minimap.lua

@@ -77,13 +77,9 @@ function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags, upda
     else
         local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
         if minimapAPIRoomDescriptor == nil then
-            if displayFlags == DisplayFlagZero then
-                return
-            end
             error("Failed to get the MinimapAPI room descriptor for the room at grid index: " .. tostring(roomGridIndex))
         end
         minimapAPIRoomDescriptor:SetDisplayFlags(displayFlags)
-        minimapAPIRoomDescriptor.Hidden = displayFlags == DisplayFlagZero
     end
 end
 --- Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
@@ -118,6 +114,10 @@ end
 -- 
 -- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
 -- the changes will be immediately visible.
+-- 
+-- Note that if you clear the display flags of a room but then the player travels to the room (or an
+-- adjacent room), the room will appear on the minimap again. If you want to permanently hide the
+-- room even in this circumstance, use the `hideRoomOnMinimap` helper function instead.
 function ____exports.clearRoomDisplayFlags(self, roomGridIndex)
     ____exports.setRoomDisplayFlags(nil, roomGridIndex, DisplayFlagZero)
 end
@@ -134,6 +134,23 @@ function ____exports.getFloorDisplayFlags(self)
     end
     return displayFlagsMap
 end
+--- Helper function to hide a specific room on the minimap.
+-- 
+-- If you want the room to be permanently hidden, you must to call this function on every new room.
+-- This is because if the player enters into the room or walks into an adjacent room, the room will
+-- reappear on the minimap.
+-- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
+function ____exports.hideRoomOnMinimap(self, roomGridIndex)
+    ____exports.clearRoomDisplayFlags(nil, roomGridIndex)
+    if MinimapAPI ~= nil then
+        local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+        if minimapAPIRoomDescriptor == nil then
+            error("Failed to get the MinimapAPI room descriptor for the room at grid index: " .. tostring(roomGridIndex))
+        end
+        minimapAPIRoomDescriptor.Hidden = true
+    end
+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": "27.6.3",
+  "version": "27.7.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/minimap.ts

@@ -44,6 +44,10 @@ export function clearFloorDisplayFlags(): void {
  *
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
  * the changes will be immediately visible.
+ *
+ * Note that if you clear the display flags of a room but then the player travels to the room (or an
+ * adjacent room), the room will appear on the minimap again. If you want to permanently hide the
+ * room even in this circumstance, use the `hideRoomOnMinimap` helper function instead.
  */
 export function clearRoomDisplayFlags(roomGridIndex: int): void {
   setRoomDisplayFlags(roomGridIndex, DisplayFlagZero);
@@ -96,6 +100,32 @@ export function getRoomDisplayFlags(
   return minimapAPIRoomDescriptor.GetDisplayFlags();
 }
 
+/**
+ * Helper function to hide a specific room on the minimap.
+ *
+ * If you want the room to be permanently hidden, you must to call this function on every new room.
+ * This is because if the player enters into the room or walks into an adjacent room, the room will
+ * reappear on the minimap.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ */
+export function hideRoomOnMinimap(roomGridIndex: int): void {
+  clearRoomDisplayFlags(roomGridIndex);
+
+  // In vanilla, the map only updates at the beginning of every room. In MinimapAPI, it constant
+  // updates, so we must specifically tell MinimapAPI that the room should be hidden using the
+  // `Hidden` property.
+  if (MinimapAPI !== undefined) {
+    const minimapAPIRoomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
+    if (minimapAPIRoomDescriptor === undefined) {
+      error(
+        `Failed to get the MinimapAPI room descriptor for the room at grid index: ${roomGridIndex}`,
+      );
+    }
+    minimapAPIRoomDescriptor.Hidden = true;
+  }
+}
+
 /**
  * Helper function to set the minimap `DisplayFlag` value for every room on the floor at once.
  *
@@ -175,16 +205,10 @@ export function setRoomDisplayFlags(
   } else {
     const minimapAPIRoomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
     if (minimapAPIRoomDescriptor === undefined) {
-      // The room might have already been removed previously.
-      if (displayFlags === DisplayFlagZero) {
-        return;
-      }
-
       error(
         `Failed to get the MinimapAPI room descriptor for the room at grid index: ${roomGridIndex}`,
       );
     }
     minimapAPIRoomDescriptor.SetDisplayFlags(displayFlags);
-    minimapAPIRoomDescriptor.Hidden = displayFlags === DisplayFlagZero;
   }
 }