isaacscript-common 21.8.2 → 21.8.3

package/dist/index.rollup.d.ts

@@ -1285,6 +1285,8 @@ export declare function clearCollectibleSprite(collectible: EntityPickup): void;
 /**
  * Helper function to set the value of `DisplayFlag` for every room on the floor to 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.
  */
@@ -4957,6 +4959,8 @@ export declare function getFlagName<T extends BitFlag | BitFlag128>(flag: BitFla
 /**
  * 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.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
  */
 export declare function getFloorDisplayFlags(): Map<int, BitFlags<DisplayFlag>>;
 
@@ -6145,6 +6149,8 @@ export declare function getRoomDescriptorReadOnly(): Readonly<RoomDescriptor>;
  * Helper function to get a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomDisplayFlags(roomGridIndex?: int): BitFlags<DisplayFlag>;
@@ -14150,6 +14156,16 @@ export declare function setAdd<T>(set: Set<T>, ...elements: T[]): void;
  */
 export declare function setAddPlayer(set: Set<PlayerIndex>, player: EntityPlayer): Set<PlayerIndex>;
 
+/**
+ * Helper function to set the minimap `DisplayFlag` value for every room on the floor at once.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ */
+export declare function setAllDisplayFlags(displayFlags: BitFlags<DisplayFlag>): void;
+
 /**
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to a particular seed.
@@ -14236,18 +14252,6 @@ export declare function setCollectibleSubType(collectible: EntityPickup, newColl
  */
 export declare function setDeletePlayer(set: Set<PlayerIndex>, player: EntityPlayer): boolean;
 
-/**
- * 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
- * the changes will be immediately visible.
- *
- * This function automatically accounts for whether or not MinimapAPI is being used.
- *
- * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
- */
-export declare function setDisplayFlags(displayFlagsMap: Map<int, BitFlags<DisplayFlag>>): void;
-
 /**
  * Helper function to make an entity flash red like it is taking damage. This is useful when you
  * want to make it appear as if an entity is taking damage without actually dealing any damage to
@@ -14296,7 +14300,16 @@ export declare function setEntityRandomColor(entity: Entity): void;
  */
 export declare function setEntityVelocities(entityVelocities: Map<PtrHash, Vector>, entities?: Entity[]): void;
 
-/** Alias for the `setDisplayFlags` function. */
+/**
+ * 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
+ * the changes will be immediately visible.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
+ * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
+ */
 export declare function setFloorDisplayFlags(displayFlagsMap: Map<int, BitFlags<DisplayFlag>>): void;
 
 /**
@@ -14347,10 +14360,14 @@ export declare function setRoomData(roomGridIndex: int, roomData: RoomConfig): v
  * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @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.
+ *                         make the changes immediately visible. Default is true. Set this to false
+ *                         if you are doing a bunch of display flag setting and then manually call
+ *                         the `Level.UpdateVisibility` method after you are done.
  */
 export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, displayFlags: BitFlags<DisplayFlag>, updateVisibility?: boolean): void;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 21.8.2
+isaacscript-common 21.8.3
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -10569,7 +10569,7 @@ ____exports.CanaryVariant.CANARY = 0
 ____exports.CanaryVariant[____exports.CanaryVariant.CANARY] = "CANARY"
 ____exports.CanaryVariant.FOREIGNER = 1
 ____exports.CanaryVariant[____exports.CanaryVariant.FOREIGNER] = "FOREIGNER"
---- For `EntityType.GAPER_L2` (850).
+--- For `EntityType.GAPER_LVL_2` (850).
 ____exports.Gaper2Variant = {}
 ____exports.Gaper2Variant.GAPER = 0
 ____exports.Gaper2Variant[____exports.Gaper2Variant.GAPER] = "GAPER"
@@ -10577,7 +10577,7 @@ ____exports.Gaper2Variant.HORF = 1
 ____exports.Gaper2Variant[____exports.Gaper2Variant.HORF] = "HORF"
 ____exports.Gaper2Variant.GUSHER = 2
 ____exports.Gaper2Variant[____exports.Gaper2Variant.GUSHER] = "GUSHER"
---- For `EntityType.CHARGER_L2` (855).
+--- For `EntityType.CHARGER_LVL_2` (855).
 ____exports.Charger2Variant = {}
 ____exports.Charger2Variant.CHARGER = 0
 ____exports.Charger2Variant[____exports.Charger2Variant.CHARGER] = "CHARGER"
@@ -51547,85 +51547,81 @@ local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomGridIndex = ____roomData.getRoomGridIndex
 local ____rooms = require("src.functions.rooms")
 local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
-function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags, updateVisibility)
-    if updateVisibility == nil then
-        updateVisibility = true
+function ____exports.getRoomDisplayFlags(self, roomGridIndex)
+    if roomGridIndex == nil then
+        roomGridIndex = getRoomGridIndex(nil)
     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
+        return roomDescriptor.DisplayFlags
+    end
+    local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+    if minimapAPIRoomDescriptor == nil then
+        error("Failed to get the MinimapAPI room descriptor for the room at index: " .. tostring(roomGridIndex))
+    end
+    return minimapAPIRoomDescriptor:GetDisplayFlags()
+end
+function ____exports.setAllDisplayFlags(self, displayFlags)
+    for ____, room in ipairs(getRoomsInsideGrid(nil)) do
+        ____exports.setRoomDisplayFlags(nil, room.SafeGridIndex, displayFlags, false)
     end
-    if updateVisibility then
+    if MinimapAPI == nil then
         local level = game:GetLevel()
         level:UpdateVisibility()
     end
 end
-function ____exports.addRoomDisplayFlag(self, roomGridIndex, displayFlag, updateVisibility)
+function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags, updateVisibility)
     if updateVisibility == nil then
         updateVisibility = true
     end
+    if roomGridIndex == nil then
+        roomGridIndex = getRoomGridIndex(nil)
+    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)
+        roomDescriptor.DisplayFlags = displayFlags
+        if updateVisibility then
+            local level = game:GetLevel()
+            level:UpdateVisibility()
         end
-        local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
-        if roomDescriptor ~= nil then
-            roomDescriptor.DisplayFlags = addFlag(nil, roomDescriptor.DisplayFlags, displayFlag)
+    else
+        local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+        if minimapAPIRoomDescriptor == nil then
+            error("Failed to get the MinimapAPI room descriptor for the room at index: " .. tostring(roomGridIndex))
         end
+        minimapAPIRoomDescriptor:SetDisplayFlags(displayFlags)
     end
-    if updateVisibility then
-        local level = game:GetLevel()
-        level:UpdateVisibility()
+end
+function ____exports.addRoomDisplayFlag(self, roomGridIndex, displayFlag, updateVisibility)
+    if updateVisibility == nil then
+        updateVisibility = true
     end
+    local oldDisplayFlags = ____exports.getRoomDisplayFlags(nil, roomGridIndex)
+    local newDisplayFlags = addFlag(nil, oldDisplayFlags, displayFlag)
+    ____exports.setRoomDisplayFlags(nil, roomGridIndex, newDisplayFlags, updateVisibility)
 end
 function ____exports.clearFloorDisplayFlags(self)
-    local level = game:GetLevel()
-    for ____, room in ipairs(getRoomsInsideGrid(nil)) do
-        room.DisplayFlags = DisplayFlagZero
-    end
-    level:UpdateVisibility()
+    ____exports.setAllDisplayFlags(nil, DisplayFlagZero)
 end
 function ____exports.getFloorDisplayFlags(self)
     local displayFlagsMap = __TS__New(Map)
-    local roomsInGrid = getRoomsInsideGrid(nil)
-    for ____, roomDescriptor in ipairs(roomsInGrid) do
-        displayFlagsMap:set(roomDescriptor.SafeGridIndex, roomDescriptor.DisplayFlags)
+    for ____, roomDescriptor in ipairs(getRoomsInsideGrid(nil)) do
+        local roomGridIndex = roomDescriptor.SafeGridIndex
+        local displayFlags = ____exports.getRoomDisplayFlags(nil, roomGridIndex)
+        displayFlagsMap:set(roomGridIndex, displayFlags)
     end
     return displayFlagsMap
 end
-function ____exports.getRoomDisplayFlags(self, roomGridIndex)
-    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.DisplayFlags
-end
-function ____exports.setDisplayFlags(self, displayFlagsMap)
-    local level = game:GetLevel()
+function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
     for ____, ____value in __TS__Iterator(displayFlagsMap) do
         local roomGridIndex = ____value[1]
         local displayFlags = ____value[2]
-        if MinimapAPI == nil then
-            ____exports.setRoomDisplayFlags(nil, roomGridIndex, displayFlags, false)
-        else
-            local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
-            if roomDescriptor ~= nil then
-                roomDescriptor.DisplayFlags = displayFlags
-            end
-        end
+        ____exports.setRoomDisplayFlags(nil, roomGridIndex, displayFlags, false)
+    end
+    if MinimapAPI == nil then
+        local level = game:GetLevel()
+        level:UpdateVisibility()
     end
-    level:UpdateVisibility()
-end
-function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
-    ____exports.setDisplayFlags(nil, displayFlagsMap)
 end
 function ____exports.setRoomVisible(self, roomGridIndex, updateVisibility)
     if updateVisibility == nil then

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

@@ -14,6 +14,8 @@ export declare function addRoomDisplayFlag(roomGridIndex: int | undefined, displ
 /**
  * Helper function to set the value of `DisplayFlag` for every room on the floor to 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.
  */
@@ -21,15 +23,28 @@ export declare function clearFloorDisplayFlags(): 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.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
  */
 export declare function getFloorDisplayFlags(): Map<int, BitFlags<DisplayFlag>>;
 /**
  * Helper function to get a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export declare function getRoomDisplayFlags(roomGridIndex?: int): BitFlags<DisplayFlag>;
+/**
+ * Helper function to set the minimap `DisplayFlag` value for every room on the floor at once.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ */
+export declare function setAllDisplayFlags(displayFlags: BitFlags<DisplayFlag>): void;
 /**
  * Helper function to set the minimap `DisplayFlag` value for multiple rooms at once.
  *
@@ -40,17 +55,19 @@ export declare function getRoomDisplayFlags(roomGridIndex?: int): BitFlags<Displ
  *
  * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
  */
-export declare function setDisplayFlags(displayFlagsMap: Map<int, BitFlags<DisplayFlag>>): void;
-/** Alias for the `setDisplayFlags` function. */
 export declare function setFloorDisplayFlags(displayFlagsMap: Map<int, BitFlags<DisplayFlag>>): void;
 /**
  * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @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.
+ *                         make the changes immediately visible. Default is true. Set this to false
+ *                         if you are doing a bunch of display flag setting and then manually call
+ *                         the `Level.UpdateVisibility` method after you are done.
  */
 export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, displayFlags: BitFlags<DisplayFlag>, updateVisibility?: boolean): void;
 /**

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,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;;;;;;;;;GASG;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"}
+{"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"}

package/dist/src/functions/minimap.lua

@@ -15,32 +15,72 @@ local getRoomDescriptor = ____roomData.getRoomDescriptor
 local getRoomGridIndex = ____roomData.getRoomGridIndex
 local ____rooms = require("src.functions.rooms")
 local getRoomsInsideGrid = ____rooms.getRoomsInsideGrid
+--- Helper function to get a particular room's minimap display flags (e.g. whether or not it is
+-- visible and so on).
+-- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
+-- 
+-- @param roomGridIndex Optional. Default is the current room index.
+function ____exports.getRoomDisplayFlags(self, roomGridIndex)
+    if roomGridIndex == nil then
+        roomGridIndex = getRoomGridIndex(nil)
+    end
+    if MinimapAPI == nil then
+        local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
+        return roomDescriptor.DisplayFlags
+    end
+    local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+    if minimapAPIRoomDescriptor == nil then
+        error("Failed to get the MinimapAPI room descriptor for the room at index: " .. tostring(roomGridIndex))
+    end
+    return minimapAPIRoomDescriptor:GetDisplayFlags()
+end
+--- Helper function to set the minimap `DisplayFlag` value for every room on the floor at once.
+-- 
+-- This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+-- the changes will be immediately visible.
+-- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
+function ____exports.setAllDisplayFlags(self, displayFlags)
+    for ____, room in ipairs(getRoomsInsideGrid(nil)) do
+        ____exports.setRoomDisplayFlags(nil, room.SafeGridIndex, displayFlags, false)
+    end
+    if MinimapAPI == nil then
+        local level = game:GetLevel()
+        level:UpdateVisibility()
+    end
+end
 --- Helper function to set a particular room's minimap display flags (e.g. whether or not it is
 -- visible and so on).
 -- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
+-- 
 -- @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.
+-- make the changes immediately visible. Default is true. Set this to false
+-- if you are doing a bunch of display flag setting and then manually call
+-- the `Level.UpdateVisibility` method after you are done.
 function ____exports.setRoomDisplayFlags(self, roomGridIndex, displayFlags, updateVisibility)
     if updateVisibility == nil then
         updateVisibility = true
     end
+    if roomGridIndex == nil then
+        roomGridIndex = getRoomGridIndex(nil)
+    end
     if MinimapAPI == nil then
         local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
         roomDescriptor.DisplayFlags = displayFlags
-    else
-        if roomGridIndex == nil then
-            roomGridIndex = getRoomGridIndex(nil)
+        if updateVisibility then
+            local level = game:GetLevel()
+            level:UpdateVisibility()
         end
-        local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
-        if roomDescriptor ~= nil then
-            roomDescriptor.DisplayFlags = displayFlags
+    else
+        local minimapAPIRoomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+        if minimapAPIRoomDescriptor == nil then
+            error("Failed to get the MinimapAPI room descriptor for the room at index: " .. tostring(roomGridIndex))
         end
-    end
-    if updateVisibility then
-        local level = game:GetLevel()
-        level:UpdateVisibility()
+        minimapAPIRoomDescriptor:SetDisplayFlags(displayFlags)
     end
 end
 --- Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
@@ -56,52 +96,32 @@ function ____exports.addRoomDisplayFlag(self, roomGridIndex, displayFlag, update
     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
+    local oldDisplayFlags = ____exports.getRoomDisplayFlags(nil, roomGridIndex)
+    local newDisplayFlags = addFlag(nil, oldDisplayFlags, displayFlag)
+    ____exports.setRoomDisplayFlags(nil, roomGridIndex, newDisplayFlags, updateVisibility)
 end
 --- Helper function to set the value of `DisplayFlag` for every room on the floor to 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.clearFloorDisplayFlags(self)
-    local level = game:GetLevel()
-    for ____, room in ipairs(getRoomsInsideGrid(nil)) do
-        room.DisplayFlags = DisplayFlagZero
-    end
-    level:UpdateVisibility()
+    ____exports.setAllDisplayFlags(nil, 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.
+-- 
+-- This function automatically accounts for whether or not MinimapAPI is being used.
 function ____exports.getFloorDisplayFlags(self)
     local displayFlagsMap = __TS__New(Map)
-    local roomsInGrid = getRoomsInsideGrid(nil)
-    for ____, roomDescriptor in ipairs(roomsInGrid) do
-        displayFlagsMap:set(roomDescriptor.SafeGridIndex, roomDescriptor.DisplayFlags)
+    for ____, roomDescriptor in ipairs(getRoomsInsideGrid(nil)) do
+        local roomGridIndex = roomDescriptor.SafeGridIndex
+        local displayFlags = ____exports.getRoomDisplayFlags(nil, roomGridIndex)
+        displayFlagsMap:set(roomGridIndex, displayFlags)
     end
     return displayFlagsMap
 end
---- Helper function to get a particular room's minimap display flags (e.g. whether or not it is
--- visible and so on).
--- 
--- @param roomGridIndex Optional. Default is the current room index.
-function ____exports.getRoomDisplayFlags(self, roomGridIndex)
-    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.DisplayFlags
-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
@@ -110,25 +130,16 @@ end
 -- This function automatically accounts for whether or not MinimapAPI is being used.
 -- 
 -- @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
-function ____exports.setDisplayFlags(self, displayFlagsMap)
-    local level = game:GetLevel()
+function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
     for ____, ____value in __TS__Iterator(displayFlagsMap) do
         local roomGridIndex = ____value[1]
         local displayFlags = ____value[2]
-        if MinimapAPI == nil then
-            ____exports.setRoomDisplayFlags(nil, roomGridIndex, displayFlags, false)
-        else
-            local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
-            if roomDescriptor ~= nil then
-                roomDescriptor.DisplayFlags = displayFlags
-            end
-        end
+        ____exports.setRoomDisplayFlags(nil, roomGridIndex, displayFlags, false)
+    end
+    if MinimapAPI == nil then
+        local level = game:GetLevel()
+        level:UpdateVisibility()
     end
-    level:UpdateVisibility()
-end
---- Alias for the `setDisplayFlags` function.
-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`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "21.8.2",
+  "version": "21.8.3",
   "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.3"
+    "isaac-typescript-definitions": "^11.1.4"
   }
 }

package/src/functions/minimap.ts

@@ -20,61 +20,36 @@ export function addRoomDisplayFlag(
   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();
-  }
+  const oldDisplayFlags = getRoomDisplayFlags(roomGridIndex);
+  const newDisplayFlags = addFlag(oldDisplayFlags, displayFlag);
+  setRoomDisplayFlags(roomGridIndex, newDisplayFlags, updateVisibility);
 }
 
 /**
  * Helper function to set the value of `DisplayFlag` for every room on the floor to 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 clearFloorDisplayFlags(): void {
-  const level = game.GetLevel();
-
-  for (const room of getRoomsInsideGrid()) {
-    room.DisplayFlags = DisplayFlagZero;
-  }
-
-  // We must call the "Level.UpdateVisibility" method for the changes to be visible.
-  level.UpdateVisibility();
+  setAllDisplayFlags(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.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
  */
 export function getFloorDisplayFlags(): Map<int, BitFlags<DisplayFlag>> {
   const displayFlagsMap = new Map<int, BitFlags<DisplayFlag>>();
 
-  const roomsInGrid = getRoomsInsideGrid();
-  for (const roomDescriptor of roomsInGrid) {
-    displayFlagsMap.set(
-      roomDescriptor.SafeGridIndex,
-      roomDescriptor.DisplayFlags,
-    );
+  for (const roomDescriptor of getRoomsInsideGrid()) {
+    const roomGridIndex = roomDescriptor.SafeGridIndex;
+    const displayFlags = getRoomDisplayFlags(roomGridIndex);
+    displayFlagsMap.set(roomGridIndex, displayFlags);
   }
 
   return displayFlagsMap;
@@ -84,13 +59,50 @@ export function getFloorDisplayFlags(): Map<int, BitFlags<DisplayFlag>> {
  * Helper function to get a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param roomGridIndex Optional. Default is the current room index.
  */
 export function getRoomDisplayFlags(
   roomGridIndex?: int,
 ): BitFlags<DisplayFlag> {
-  const roomDescriptor = getRoomDescriptor(roomGridIndex);
-  return roomDescriptor.DisplayFlags;
+  if (roomGridIndex === undefined) {
+    roomGridIndex = getRoomGridIndex();
+  }
+
+  if (MinimapAPI === undefined) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    return roomDescriptor.DisplayFlags;
+  }
+
+  const minimapAPIRoomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
+  if (minimapAPIRoomDescriptor === undefined) {
+    error(
+      `Failed to get the MinimapAPI room descriptor for the room at index: ${roomGridIndex}`,
+    );
+  }
+  return minimapAPIRoomDescriptor.GetDisplayFlags();
+}
+
+/**
+ * Helper function to set the minimap `DisplayFlag` value for every room on the floor at once.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ */
+export function setAllDisplayFlags(displayFlags: BitFlags<DisplayFlag>): void {
+  for (const room of getRoomsInsideGrid()) {
+    // We pass false to the `updateVisibility` argument as a small optimization.
+    setRoomDisplayFlags(room.SafeGridIndex, displayFlags, false);
+  }
+
+  // In vanilla, we must call the "Level.UpdateVisibility" method for the changes to be visible.
+  if (MinimapAPI === undefined) {
+    const level = game.GetLevel();
+    level.UpdateVisibility();
+  }
 }
 
 /**
@@ -103,64 +115,59 @@ export function getRoomDisplayFlags(
  *
  * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
  */
-export function setDisplayFlags(
+export function setFloorDisplayFlags(
   displayFlagsMap: Map<int, BitFlags<DisplayFlag>>,
 ): void {
-  const level = game.GetLevel();
-
   for (const [roomGridIndex, displayFlags] of displayFlagsMap) {
-    if (MinimapAPI === undefined) {
-      // We pass false to the `updateVisibility` argument as a small optimization.
-      setRoomDisplayFlags(roomGridIndex, displayFlags, false);
-    } else {
-      const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
-      if (roomDescriptor !== undefined) {
-        roomDescriptor.DisplayFlags = displayFlags;
-      }
-    }
+    // We pass false to the `updateVisibility` argument as a small optimization.
+    setRoomDisplayFlags(roomGridIndex, displayFlags, false);
   }
 
-  // We must call the "Level.UpdateVisibility" method for the changes to be visible.
-  level.UpdateVisibility();
-}
-
-/** Alias for the `setDisplayFlags` function. */
-export function setFloorDisplayFlags(
-  displayFlagsMap: Map<int, BitFlags<DisplayFlag>>,
-): void {
-  setDisplayFlags(displayFlagsMap);
+  // In vanilla, we must call the "Level.UpdateVisibility" method for the changes to be visible.
+  if (MinimapAPI === undefined) {
+    const level = game.GetLevel();
+    level.UpdateVisibility();
+  }
 }
 
 /**
  * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @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.
+ *                         make the changes immediately visible. Default is true. Set this to false
+ *                         if you are doing a bunch of display flag setting and then manually call
+ *                         the `Level.UpdateVisibility` method after you are done.
  */
 export function setRoomDisplayFlags(
   roomGridIndex: int | undefined,
   displayFlags: BitFlags<DisplayFlag>,
   updateVisibility = true,
 ): void {
+  if (roomGridIndex === undefined) {
+    roomGridIndex = getRoomGridIndex();
+  }
+
   if (MinimapAPI === undefined) {
     const roomDescriptor = getRoomDescriptor(roomGridIndex);
     roomDescriptor.DisplayFlags = displayFlags;
-  } else {
-    if (roomGridIndex === undefined) {
-      roomGridIndex = getRoomGridIndex();
+
+    if (updateVisibility) {
+      const level = game.GetLevel();
+      level.UpdateVisibility();
     }
-    const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
-    if (roomDescriptor !== undefined) {
-      roomDescriptor.DisplayFlags = displayFlags;
+  } else {
+    const minimapAPIRoomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
+    if (minimapAPIRoomDescriptor === undefined) {
+      error(
+        `Failed to get the MinimapAPI room descriptor for the room at index: ${roomGridIndex}`,
+      );
     }
-  }
-
-  if (updateVisibility) {
-    const level = game.GetLevel();
-    level.UpdateVisibility();
+    minimapAPIRoomDescriptor.SetDisplayFlags(displayFlags);
   }
 }