isaacscript-common 9.15.0 → 9.16.0

package/dist/functions/minimap.d.ts

@@ -1,4 +1,14 @@
 import { DisplayFlag } from "isaac-typescript-definitions";
+/**
+ * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
+ * or not it is visible and so on).
+ *
+ * @param roomGridIndex Set to undefined to use the current room index.
+ * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
+ */
+export declare function addRoomDisplayFlag(roomGridIndex: int | undefined, displayFlag: DisplayFlag, updateVisibility?: boolean): void;
 /**
  * Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
  *
@@ -33,11 +43,19 @@ export declare function setFloorDisplayFlags(displayFlagsMap: Map<int, BitFlags<
  * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
- * You must call the `Level.UpdateVisibility` method after using this function for the changes to
- * take effect.
- *
  * @param roomGridIndex Set to undefined to use the current room index.
  * @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
+ */
+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 setRoomDisplayFlags(roomGridIndex: int | undefined, displayFlags: BitFlags<DisplayFlag>): void;
+export declare function setRoomVisible(roomGridIndex: int | undefined, updateVisibility?: boolean): void;
 //# sourceMappingURL=minimap.d.ts.map

package/dist/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;AAK5E;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAS7C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAYtE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,GAClB,QAAQ,CAAC,WAAW,CAAC,CAGvB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAgBN;AAED,gDAAgD;AAChD,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAEN;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,GAClC,IAAI,CAGN"}
+{"version":3,"file":"minimap.d.ts","sourceRoot":"","sources":["../../src/functions/minimap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,8BAA8B,CAAC;AAM5E;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,WAAW,EAAE,WAAW,EACxB,gBAAgB,UAAO,GACtB,IAAI,CAwBN;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAS7C;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAYtE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,GAAG,GAClB,QAAQ,CAAC,WAAW,CAAC,CAGvB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAiBN;AAED,gDAAgD;AAChD,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,GAC/C,IAAI,CAEN;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,YAAY,EAAE,QAAQ,CAAC,WAAW,CAAC,EACnC,gBAAgB,UAAO,GACtB,IAAI,CAkBN;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,aAAa,EAAE,GAAG,GAAG,SAAS,EAC9B,gBAAgB,UAAO,GACtB,IAAI,CAEN"}

package/dist/functions/minimap.lua

@@ -4,24 +4,72 @@ 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("core.cachedClasses")
 local game = ____cachedClasses.game
+local ____flag = require("functions.flag")
+local addFlag = ____flag.addFlag
 local ____roomData = require("functions.roomData")
 local getRoomDescriptor = ____roomData.getRoomDescriptor
+local getRoomGridIndex = ____roomData.getRoomGridIndex
 local ____rooms = require("functions.rooms")
 local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
 --- Helper function to set a particular room's minimap display flags (e.g. whether or not it is
 -- visible and so on).
 -- 
--- You must call the `Level.UpdateVisibility` method after using this function for the changes to
--- take effect.
--- 
 -- @param roomGridIndex Set to undefined to use the current room index.
 -- @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
-function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags)
-    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
-    roomDescriptor.DisplayFlags = displayFlags
+-- @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+-- make the changes immediately visible. Default is true.
+function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags, updateVisibility)
+    if updateVisibility == nil then
+        updateVisibility = true
+    end
+    if MinimapAPI == nil then
+        local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+        roomDescriptor.DisplayFlags = displayFlags
+    else
+        if roomGridIndex == nil then
+            roomGridIndex = getRoomGridIndex(nil)
+        end
+        local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+        if roomDescriptor ~= nil then
+            roomDescriptor.DisplayFlags = displayFlags
+        end
+    end
+    if updateVisibility then
+        local level = game:GetLevel()
+        level:UpdateVisibility()
+    end
+end
+--- Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
+-- or not it is visible and so on).
+-- 
+-- @param roomGridIndex Set to undefined to use the current room index.
+-- @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
+-- @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+-- make the changes immediately visible. Default is true.
+function ____exports.addRoomDisplayFlag(self, roomGridIndex, displayFlag, updateVisibility)
+    if updateVisibility == nil then
+        updateVisibility = true
+    end
+    if MinimapAPI == nil then
+        local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+        roomDescriptor.DisplayFlags = addFlag(nil, roomDescriptor.DisplayFlags, displayFlag)
+    else
+        if roomGridIndex == nil then
+            roomGridIndex = getRoomGridIndex(nil)
+        end
+        local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+        if roomDescriptor ~= nil then
+            roomDescriptor.DisplayFlags = addFlag(nil, roomDescriptor.DisplayFlags, displayFlag)
+        end
+    end
+    if updateVisibility then
+        local level = game:GetLevel()
+        level:UpdateVisibility()
+    end
 end
 --- Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
 -- 
@@ -64,7 +112,7 @@ function ____exports.setDisplayFlags(self, displayFlagsMap)
         local roomGridIndex = ____value[1]
         local displayFlags = ____value[2]
         if MinimapAPI == nil then
-            ____exports.setRoomDisplayFlags(nil, roomGridIndex, displayFlags)
+            ____exports.setRoomDisplayFlags(nil, roomGridIndex, displayFlags, false)
         else
             local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
             if roomDescriptor ~= nil then
@@ -78,4 +126,16 @@ end
 function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
     ____exports.setDisplayFlags(nil, displayFlagsMap)
 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/dist/index.d.ts

@@ -287,6 +287,17 @@ export declare function addRoomClearCharges(bigRoomDoubleCharge?: boolean): void
  */
 export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, bigRoomDoubleCharge?: boolean, playSoundEffect?: boolean): void;
 
+/**
+ * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
+ * or not it is visible and so on).
+ *
+ * @param roomGridIndex Set to undefined to use the current room index.
+ * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
+ */
+export declare function addRoomDisplayFlag(roomGridIndex: int | undefined, displayFlag: DisplayFlag, updateVisibility?: boolean): void;
+
 /**
  * Helper function to add all of the values in one set to another set. The first set passed will be
  * modified in place.
@@ -10728,13 +10739,12 @@ export declare function setRoomData(roomGridIndex: int, roomData: Readonly<RoomC
  * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
- * You must call the `Level.UpdateVisibility` method after using this function for the changes to
- * take effect.
- *
  * @param roomGridIndex Set to undefined to use the current room index.
  * @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
  */
-export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, displayFlags: BitFlags<DisplayFlag>): void;
+export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, displayFlags: BitFlags<DisplayFlag>, updateVisibility?: boolean): void;
 
 /**
  * Helper function to emulate what happens when you bomb an Angel Statue or push a Reward Plate that
@@ -10742,6 +10752,16 @@ 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/package.json

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

package/src/functions/minimap.ts

@@ -1,8 +1,48 @@
 import { DisplayFlag, DisplayFlagZero } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
-import { getRoomDescriptor } from "./roomData";
+import { addFlag } from "./flag";
+import { getRoomDescriptor, getRoomGridIndex } from "./roomData";
 import { getRoomsInsideGrid } from "./rooms";
 
+/**
+ * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
+ * or not it is visible and so on).
+ *
+ * @param roomGridIndex Set to undefined to use the current room index.
+ * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
+ */
+export function addRoomDisplayFlag(
+  roomGridIndex: int | undefined,
+  displayFlag: DisplayFlag,
+  updateVisibility = true,
+): void {
+  if (MinimapAPI === undefined) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    roomDescriptor.DisplayFlags = addFlag(
+      roomDescriptor.DisplayFlags,
+      displayFlag,
+    );
+  } else {
+    if (roomGridIndex === undefined) {
+      roomGridIndex = getRoomGridIndex();
+    }
+    const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
+    if (roomDescriptor !== undefined) {
+      roomDescriptor.DisplayFlags = addFlag(
+        roomDescriptor.DisplayFlags,
+        displayFlag,
+      );
+    }
+  }
+
+  if (updateVisibility) {
+    const level = game.GetLevel();
+    level.UpdateVisibility();
+  }
+}
+
 /**
  * Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
  *
@@ -66,7 +106,8 @@ export function setDisplayFlags(
 
   for (const [roomGridIndex, displayFlags] of displayFlagsMap.entries()) {
     if (MinimapAPI === undefined) {
-      setRoomDisplayFlags(roomGridIndex, displayFlags);
+      // We pass false to the `updateVisibility` argument as a small optimization.
+      setRoomDisplayFlags(roomGridIndex, displayFlags, false);
     } else {
       const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
       if (roomDescriptor !== undefined) {
@@ -90,16 +131,46 @@ export function setFloorDisplayFlags(
  * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
- * You must call the `Level.UpdateVisibility` method after using this function for the changes to
- * take effect.
- *
  * @param roomGridIndex Set to undefined to use the current room index.
  * @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
  */
 export function setRoomDisplayFlags(
   roomGridIndex: int | undefined,
   displayFlags: BitFlags<DisplayFlag>,
+  updateVisibility = true,
 ): void {
-  const roomDescriptor = getRoomDescriptor(roomGridIndex);
-  roomDescriptor.DisplayFlags = displayFlags;
+  if (MinimapAPI === undefined) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    roomDescriptor.DisplayFlags = displayFlags;
+  } else {
+    if (roomGridIndex === undefined) {
+      roomGridIndex = getRoomGridIndex();
+    }
+    const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
+    if (roomDescriptor !== undefined) {
+      roomDescriptor.DisplayFlags = displayFlags;
+    }
+  }
+
+  if (updateVisibility) {
+    const level = game.GetLevel();
+    level.UpdateVisibility();
+  }
+}
+
+/**
+ * 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);
 }