Minimap
Functions
Section titled “Functions”addRoomDisplayFlag()
Section titled “addRoomDisplayFlag()”addRoomDisplayFlag(
roomGridIndex,displayFlag,updateVisibility?):void
Defined in: packages/isaacscript-common/src/functions/minimap.ts:21
Helper function to add a DisplayFlag to a particular room’s minimap display flags (e.g. whether
it is visible and so on).
This function automatically accounts for if MinimapAPI is being used.
Parameters
Section titled “Parameters”roomGridIndex
Section titled “roomGridIndex”int | undefined
Set to undefined to use the current room index.
displayFlag
Section titled “displayFlag”DisplayFlagValue
The DisplayFlag to set. (See the DisplayFlag enum.)
updateVisibility?
Section titled “updateVisibility?”boolean = true
Optional. Whether to call the Level.UpdateVisibility method in order to
make the changes immediately visible. Default is true.
Returns
Section titled “Returns”void
clearFloorDisplayFlags()
Section titled “clearFloorDisplayFlags()”clearFloorDisplayFlags():
void
Defined in: packages/isaacscript-common/src/functions/minimap.ts:39
Helper function to set the value of DisplayFlag for every room on the floor to 0.
This function automatically accounts for if MinimapAPI is being used.
This function automatically calls the Level.UpdateVisibility after setting the flags so that
the changes will be immediately visible.
Returns
Section titled “Returns”void
clearRoomDisplayFlags()
Section titled “clearRoomDisplayFlags()”clearRoomDisplayFlags(
roomGridIndex):void
Defined in: packages/isaacscript-common/src/functions/minimap.ts:55
Helper function to set the value of DisplayFlag for a room 0.
This function automatically accounts for if MinimapAPI is being used.
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.
Parameters
Section titled “Parameters”roomGridIndex
Section titled “roomGridIndex”int
Returns
Section titled “Returns”void
getFloorDisplayFlags()
Section titled “getFloorDisplayFlags()”getFloorDisplayFlags(
minimapAPI?):ReadonlyMap<int,BitFlags<DisplayFlagValue>>
Defined in: packages/isaacscript-common/src/functions/minimap.ts:67
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 if MinimapAPI is being used.
Parameters
Section titled “Parameters”minimapAPI?
Section titled “minimapAPI?”boolean = true
Optional. If MinimapAPI should be used, if present. Default is true.
Returns
Section titled “Returns”ReadonlyMap<int, BitFlags<DisplayFlagValue>>
getRoomDisplayFlags()
Section titled “getRoomDisplayFlags()”getRoomDisplayFlags(
roomGridIndex?,minimapAPI?):BitFlags<DisplayFlagValue>
Defined in: packages/isaacscript-common/src/functions/minimap.ts:90
Helper function to get a particular room’s minimap display flags (e.g. whether it is visible and so on).
This function automatically accounts for if MinimapAPI is being used.
Parameters
Section titled “Parameters”roomGridIndex?
Section titled “roomGridIndex?”int
Optional. Default is the current room index.
minimapAPI?
Section titled “minimapAPI?”boolean = true
Optional. If MinimapAPI should be used, if present. Default is true.
Returns
Section titled “Returns”BitFlags<DisplayFlagValue>
hideRoomOnMinimap()
Section titled “hideRoomOnMinimap()”hideRoomOnMinimap(
roomGridIndex):void
Defined in: packages/isaacscript-common/src/functions/minimap.ts:119
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 if MinimapAPI is being used.
Parameters
Section titled “Parameters”roomGridIndex
Section titled “roomGridIndex”int
Returns
Section titled “Returns”void
isRoomVisible()
Section titled “isRoomVisible()”isRoomVisible(
roomGridIndexOrRoomDescriptor,minimapAPI?):boolean
Defined in: packages/isaacscript-common/src/functions/minimap.ts:142
Helper function to check if a given room is visible on the minimap.
Parameters
Section titled “Parameters”roomGridIndexOrRoomDescriptor
Section titled “roomGridIndexOrRoomDescriptor”int | RoomDescriptor
The room to check.
minimapAPI?
Section titled “minimapAPI?”boolean = true
Optional. Whether MinimapAPI should be used, if present. Default is true.
Returns
Section titled “Returns”boolean
setAllDisplayFlags()
Section titled “setAllDisplayFlags()”setAllDisplayFlags(
displayFlags):void
Defined in: packages/isaacscript-common/src/functions/minimap.ts:162
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 if MinimapAPI is being used.
Parameters
Section titled “Parameters”displayFlags
Section titled “displayFlags”BitFlags<DisplayFlagValue>
Returns
Section titled “Returns”void
setFloorDisplayFlags()
Section titled “setFloorDisplayFlags()”setFloorDisplayFlags(
displayFlagsMap):void
Defined in: packages/isaacscript-common/src/functions/minimap.ts:185
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 if MinimapAPI is being used.
Parameters
Section titled “Parameters”displayFlagsMap
Section titled “displayFlagsMap”ReadonlyMap<int, BitFlags<DisplayFlagValue>>
A map of the display flags that is indexed by the room’s safe grid index.
Returns
Section titled “Returns”void
setRoomDisplayFlags()
Section titled “setRoomDisplayFlags()”setRoomDisplayFlags(
roomGridIndex,displayFlags,updateVisibility?):void
Defined in: packages/isaacscript-common/src/functions/minimap.ts:213
Helper function to set a particular room’s minimap display flags (e.g. whether it is visible and so on).
This function automatically accounts for if MinimapAPI is being used.
Parameters
Section titled “Parameters”roomGridIndex
Section titled “roomGridIndex”int | undefined
Set to undefined to use the current room index.
displayFlags
Section titled “displayFlags”BitFlags<DisplayFlagValue>
The bit flags value to set. (See the DisplayFlag enum.)
updateVisibility?
Section titled “updateVisibility?”boolean = true
Optional. Whether to call the Level.UpdateVisibility method in order to
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.
Returns
Section titled “Returns”void