isaacscript-common 21.8.3 → 21.9.0

package/dist/index.rollup.d.ts

@@ -1292,6 +1292,16 @@ export declare function clearCollectibleSprite(collectible: EntityPickup): void;
  */
 export declare function clearFloorDisplayFlags(): void;
 
+/**
+ * Helper function to set the value of `DisplayFlag` for a room 0.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ */
+export declare function clearRoomDisplayFlags(roomGridIndex: int): void;
+
 /**
  * Helper function to clear all layers or specific layers from a sprite without unloading the
  * attached anm2 file.
@@ -14377,16 +14387,6 @@ export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, disp
  */
 export declare function setRoomUncleared(): void;
 
-/**
- * Helper function to make a single room visible in a similar way to how the Compass makes a Boss
- * Room visible (e.g. by adding `DisplayFlag.SHOW_ICON`).
- *
- * @param roomGridIndex Set to undefined to use the current room index.
- * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
- *                         make the changes immediately visible. Default is true.
- */
-export declare function setRoomVisible(roomGridIndex: int | undefined, updateVisibility?: boolean): void;
-
 /** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
 export declare function setSeed(rng: RNG, seed: Seed): void;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 21.8.3
+isaacscript-common 21.9.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -51536,7 +51536,6 @@ local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
-local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
 local DisplayFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlagZero
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
@@ -51587,9 +51586,15 @@ 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 index: " .. tostring(roomGridIndex))
         end
         minimapAPIRoomDescriptor:SetDisplayFlags(displayFlags)
+        if displayFlags == DisplayFlagZero then
+            minimapAPIRoomDescriptor:Remove()
+        end
     end
 end
 function ____exports.addRoomDisplayFlag(self, roomGridIndex, displayFlag, updateVisibility)
@@ -51603,6 +51608,9 @@ end
 function ____exports.clearFloorDisplayFlags(self)
     ____exports.setAllDisplayFlags(nil, DisplayFlagZero)
 end
+function ____exports.clearRoomDisplayFlags(self, roomGridIndex)
+    ____exports.setRoomDisplayFlags(nil, roomGridIndex, DisplayFlagZero)
+end
 function ____exports.getFloorDisplayFlags(self)
     local displayFlagsMap = __TS__New(Map)
     for ____, roomDescriptor in ipairs(getRoomsInsideGrid(nil)) do
@@ -51623,12 +51631,6 @@ function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
         level:UpdateVisibility()
     end
 end
-function ____exports.setRoomVisible(self, roomGridIndex, updateVisibility)
-    if updateVisibility == nil then
-        updateVisibility = true
-    end
-    ____exports.addRoomDisplayFlag(nil, roomGridIndex, DisplayFlag.SHOW_ICON, updateVisibility)
-end
 return ____exports
  end,
 ["src.functions.modFeatures"] = function(...) 

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

@@ -20,6 +20,15 @@ export declare function addRoomDisplayFlag(roomGridIndex: int | undefined, displ
  * the changes will be immediately visible.
  */
 export declare function clearFloorDisplayFlags(): void;
+/**
+ * Helper function to set the value of `DisplayFlag` for a room 0.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ */
+export declare function clearRoomDisplayFlags(roomGridIndex: int): void;
 /**
  * Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
  * that is indexed by the room's safe grid index.
@@ -70,13 +79,4 @@ export declare function setFloorDisplayFlags(displayFlagsMap: Map<int, BitFlags<
  *                         the `Level.UpdateVisibility` method after you are done.
  */
 export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, displayFlags: BitFlags<DisplayFlag>, updateVisibility?: boolean): void;
-/**
- * Helper function to make a single room visible in a similar way to how the Compass makes a Boss
- * Room visible (e.g. by adding `DisplayFlag.SHOW_ICON`).
- *
- * @param roomGridIndex Set to undefined to use the current room index.
- * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
- *                         make the changes immediately visible. Default is true.
- */
-export declare function setRoomVisible(roomGridIndex: int | undefined, updateVisibility?: boolean): void;
 //# sourceMappingURL=minimap.d.ts.map

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;;;;;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,CAsBN;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,gBAAgB,UAAO,GACtB,IAAI,CAEN"}
+{"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,CAiCN"}

package/dist/src/functions/minimap.lua

@@ -4,7 +4,6 @@ local __TS__New = ____lualib.__TS__New
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local DisplayFlag = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlag
 local DisplayFlagZero = ____isaac_2Dtypescript_2Ddefinitions.DisplayFlagZero
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
@@ -78,9 +77,15 @@ 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 index: " .. tostring(roomGridIndex))
         end
         minimapAPIRoomDescriptor:SetDisplayFlags(displayFlags)
+        if displayFlags == DisplayFlagZero then
+            minimapAPIRoomDescriptor:Remove()
+        end
     end
 end
 --- Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
@@ -109,6 +114,15 @@ end
 function ____exports.clearFloorDisplayFlags(self)
     ____exports.setAllDisplayFlags(nil, DisplayFlagZero)
 end
+--- Helper function to set the value of `DisplayFlag` for a room 0.
+-- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
+-- 
+-- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+-- the changes will be immediately visible.
+function ____exports.clearRoomDisplayFlags(self, roomGridIndex)
+    ____exports.setRoomDisplayFlags(nil, roomGridIndex, DisplayFlagZero)
+end
 --- Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
 -- that is indexed by the room's safe grid index.
 -- 
@@ -141,16 +155,4 @@ function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
         level:UpdateVisibility()
     end
 end
---- Helper function to make a single room visible in a similar way to how the Compass makes a Boss
--- Room visible (e.g. by adding `DisplayFlag.SHOW_ICON`).
--- 
--- @param roomGridIndex Set to undefined to use the current room index.
--- @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
--- make the changes immediately visible. Default is true.
-function ____exports.setRoomVisible(self, roomGridIndex, updateVisibility)
-    if updateVisibility == nil then
-        updateVisibility = true
-    end
-    ____exports.addRoomDisplayFlag(nil, roomGridIndex, DisplayFlag.SHOW_ICON, updateVisibility)
-end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "21.8.3",
+  "version": "21.9.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/src/index",
   "types": "dist/index.rollup.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^11.1.4"
+    "isaac-typescript-definitions": "^11.1.5"
   }
 }

package/src/functions/minimap.ts

@@ -37,6 +37,18 @@ export function clearFloorDisplayFlags(): void {
   setAllDisplayFlags(DisplayFlagZero);
 }
 
+/**
+ * Helper function to set the value of `DisplayFlag` for a room 0.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ */
+export function clearRoomDisplayFlags(roomGridIndex: int): void {
+  setRoomDisplayFlags(roomGridIndex, DisplayFlagZero);
+}
+
 /**
  * Helper function to get the minimap `DisplayFlag` value for every room on the floor. Returns a map
  * that is indexed by the room's safe grid index.
@@ -163,25 +175,21 @@ 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 index: ${roomGridIndex}`,
       );
     }
     minimapAPIRoomDescriptor.SetDisplayFlags(displayFlags);
-  }
-}
 
-/**
- * Helper function to make a single room visible in a similar way to how the Compass makes a Boss
- * Room visible (e.g. by adding `DisplayFlag.SHOW_ICON`).
- *
- * @param roomGridIndex Set to undefined to use the current room index.
- * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
- *                         make the changes immediately visible. Default is true.
- */
-export function setRoomVisible(
-  roomGridIndex: int | undefined,
-  updateVisibility = true,
-): void {
-  addRoomDisplayFlag(roomGridIndex, DisplayFlag.SHOW_ICON, updateVisibility);
+    // MinimapAPI is bugged such that setting the display flags to 0 does not make the room
+    // invisible. We delete the room to work around this.
+    if (displayFlags === DisplayFlagZero) {
+      minimapAPIRoomDescriptor.Remove();
+    }
+  }
 }