isaacscript-common 4.3.1 → 4.4.0

package/features/extraConsoleCommands/commandsSubroutines.d.ts

@@ -5,5 +5,5 @@ export declare function devilAngel(useDevil: boolean): void;
 export declare function listEntities(params: string, includeBackgroundEffects: boolean): void;
 export declare function listGridEntities(params: string, includeWalls: boolean): void;
 export declare function movePlayer(params: string, direction: Direction): void;
-export declare function spawnTrapdoorOrCrawlspace(trapdoor: boolean): void;
+export declare function spawnTrapdoorOrCrawlSpace(trapdoor: boolean): void;
 export declare function warpToRoomType(roomType: RoomType): void;

package/features/extraConsoleCommands/commandsSubroutines.lua

@@ -98,7 +98,7 @@ function ____exports.movePlayer(self, params, direction)
     local modifiedVector = vector * amount
     player.Position = player.Position + modifiedVector
 end
-function ____exports.spawnTrapdoorOrCrawlspace(self, trapdoor)
+function ____exports.spawnTrapdoorOrCrawlSpace(self, trapdoor)
     local room = game:GetRoom()
     local player = Isaac.GetPlayer()
     local position = room:FindFreeTilePosition(player.Position, 0)

package/features/extraConsoleCommands/init.lua

@@ -146,7 +146,7 @@ commandFunctionsMap:set("charge", commands.charge)
 commandFunctionsMap:set("cleanBedroom", commands.cleanBedroom)
 commandFunctionsMap:set("coin", commands.coin)
 commandFunctionsMap:set("coins", commands.coins)
-commandFunctionsMap:set("crawlspace", commands.crawlspace)
+commandFunctionsMap:set("crawlSpace", commands.crawlSpace)
 commandFunctionsMap:set("d20", commands.d20)
 commandFunctionsMap:set("d6", commands.d6)
 commandFunctionsMap:set("damage", commands.damage)

package/features/extraConsoleCommands/listCommands.d.ts

@@ -90,8 +90,8 @@ export declare function coin(params: string): void;
  * to remove coins.)
  */
 export declare function coins(params: string): void;
-/** Creates a crawlspace next to the player. */
-export declare function crawlspace(): void;
+/** Creates a crawl space next to the player. */
+export declare function crawlSpace(): void;
 /** Uses the D20. */
 export declare function d20(): void;
 /** Uses the D6. */
@@ -111,7 +111,7 @@ export declare function dirtyBedroom(): void;
 export declare function disableCurses(): void;
 /** Moves the player 0.5 units down. Provide a number to move a custom amount of units. */
 export declare function down(params: string): void;
-/** Warps to the Dungeon (i.e. Crawlspace) for the floor. */
+/** Warps to the Dungeon (i.e. crawl space) for the floor. */
 export declare function dungeon(): void;
 /** Logs the player's current temporary effects to the "log.txt" file. */
 export declare function effects(): void;

package/features/extraConsoleCommands/listCommands.lua

@@ -93,7 +93,7 @@ local devilAngel = ____commandsSubroutines.devilAngel
 local listEntities = ____commandsSubroutines.listEntities
 local listGridEntities = ____commandsSubroutines.listGridEntities
 local movePlayer = ____commandsSubroutines.movePlayer
-local spawnTrapdoorOrCrawlspace = ____commandsSubroutines.spawnTrapdoorOrCrawlspace
+local spawnTrapdoorOrCrawlSpace = ____commandsSubroutines.spawnTrapdoorOrCrawlSpace
 local warpToRoomType = ____commandsSubroutines.warpToRoomType
 local ____v = require("features.extraConsoleCommands.v")
 local v = ____v.default
@@ -466,9 +466,9 @@ function ____exports.coins(self, params)
     local player = Isaac.GetPlayer()
     player:AddCoins(numCoins)
 end
---- Creates a crawlspace next to the player.
-function ____exports.crawlspace(self)
-    spawnTrapdoorOrCrawlspace(nil, false)
+--- Creates a crawl space next to the player.
+function ____exports.crawlSpace(self)
+    spawnTrapdoorOrCrawlSpace(nil, false)
 end
 --- Uses the D20.
 function ____exports.d20(self)
@@ -502,7 +502,7 @@ end
 function ____exports.down(self, params)
     movePlayer(nil, params, Direction.DOWN)
 end
---- Warps to the Dungeon (i.e. Crawlspace) for the floor.
+--- Warps to the Dungeon (i.e. crawl space) for the floor.
 function ____exports.dungeon(self)
     changeRoom(nil, GridRoom.DUNGEON)
 end
@@ -1050,7 +1050,7 @@ function ____exports.tears(self)
 end
 --- Creates a trapdoor next to the player.
 function ____exports.trapdoorCommand(self)
-    spawnTrapdoorOrCrawlspace(nil, true)
+    spawnTrapdoorOrCrawlSpace(nil, true)
 end
 --- Warps to the first Treasure Room on the floor.
 function ____exports.treasure(self)

package/functions/minimap.d.ts

@@ -0,0 +1,32 @@
+import { DisplayFlag } from "isaac-typescript-definitions";
+/**
+ * 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.
+ */
+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).
+ *
+ * @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 multiple rooms at once.
+ *
+ * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
+ * the changes will be immediately visible.
+ *
+ * @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).
+ *
+ * @param roomGridIndex Set to undefined to use the current room index.
+ * @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
+ */
+export declare function setRoomDisplayFlags(roomGridIndex: int | undefined, displayFlags: BitFlags<DisplayFlag>): void;

package/functions/minimap.lua

@@ -0,0 +1,65 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____roomData = require("functions.roomData")
+local getRoomDescriptor = ____roomData.getRoomDescriptor
+local ____rooms = require("functions.rooms")
+local getRoomsInGrid = ____rooms.getRoomsInGrid
+--- Helper function to set 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 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
+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.
+function ____exports.getFloorDisplayFlags(self)
+    local displayFlagsMap = __TS__New(Map)
+    local roomsInGrid = getRoomsInGrid(nil)
+    for ____, roomDescriptor in ipairs(roomsInGrid) do
+        displayFlagsMap:set(roomDescriptor.SafeGridIndex, roomDescriptor.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
+-- the changes will be immediately visible.
+-- 
+-- @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()
+    for ____, ____value in __TS__Iterator(displayFlagsMap:entries()) do
+        local roomGridIndex = ____value[1]
+        local displayFlags = ____value[2]
+        if MinimapAPI == nil then
+            ____exports.setRoomDisplayFlags(nil, roomGridIndex, displayFlags)
+        else
+            local roomDescriptor = MinimapAPI:GetRoomByIdx(roomGridIndex)
+            if roomDescriptor ~= nil then
+                roomDescriptor.DisplayFlags = displayFlags
+            end
+        end
+    end
+    level:UpdateVisibility()
+end
+--- Alias for the `setDisplayFlags` function.
+function ____exports.setFloorDisplayFlags(self, displayFlagsMap)
+    ____exports.setDisplayFlags(nil, displayFlagsMap)
+end
+return ____exports

package/functions/nextStage.d.ts

@@ -13,6 +13,6 @@ export declare function getNextStage(): LevelStage;
  * based on the current stage, room, and game state flags.
  *
  * @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
- *                2. Defaults to false.
+ *                2. Default is false.
  */
 export declare function getNextStageType(upwards?: boolean): StageType;

package/functions/nextStage.lua

@@ -200,7 +200,7 @@ end
 -- based on the current stage, room, and game state flags.
 -- 
 -- @param upwards Whether or not the player should go up to Cathedral in the case of being on Womb
--- 2. Defaults to false.
+-- 2. Default is false.
 function ____exports.getNextStageType(self, upwards)
     if upwards == nil then
         upwards = false
@@ -240,6 +240,12 @@ function ____exports.getNextStageType(self, upwards)
         end
         return StageType.WRATH_OF_THE_LAMB
     end
+    if nextStage == LevelStage.THE_VOID then
+        return StageType.ORIGINAL
+    end
+    if nextStage == LevelStage.HOME then
+        return StageType.ORIGINAL
+    end
     return calculateStageType(nil, nextStage)
 end
 return ____exports

package/functions/rooms.d.ts

@@ -49,15 +49,25 @@ export declare function getRoomShapeNeighborGridIndexDeltas(roomShape: RoomShape
  */
 export declare function getRoomTypeName(roomType: RoomType): string;
 /**
- * Helper function to get the room descriptor for every room on the level. Uses the `Level.GetRooms`
- * method to accomplish this. Rooms without data are assumed to be non-existent and are not added to
- * the list.
+ * Helper function to get the room descriptor for every room on the level, including off-grid rooms.
+ * Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
+ * non-existent and are not added to the list.
  *
  * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
  *                                 extra-dimensional rooms are automatically be generated and can be
  *                                 seen when you iterate over the `RoomList`. Default is false.
  */
 export declare function getRooms(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
+/**
+ * Helper function to get the room descriptor for every room on the level except for rooms that are
+ * not on the grid. Uses the `Level.GetRooms` method to accomplish this. Rooms without data are
+ * assumed to be non-existent and are not added to the list.
+ *
+ * @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
+ *                                 extra-dimensional rooms are automatically be generated and can be
+ *                                 seen when you iterate over the `RoomList`. Default is false.
+ */
+export declare function getRoomsInGrid(includeExtraDimensionalRooms?: boolean): RoomDescriptor[];
 /**
  * Helper function to get the room descriptor for every room on the level in a specific dimension.
  * Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
@@ -79,11 +89,11 @@ export declare function inBeastRoom(): boolean;
  */
 export declare function inBossRoomOf(bossID: BossID): boolean;
 /**
- * Helper function for determining whether the current room is a crawlspace. Use this function over
+ * Helper function for determining whether the current room is a crawl space. Use this function over
  * comparing to `RoomType.DUNGEON` or `GridRoom.DUNGEON_IDX` since there is a special case of the
  * player being in a boss fight that take place in a dungeon.
  */
-export declare function inCrawlspace(): boolean;
+export declare function inCrawlSpace(): boolean;
 /**
  * We cannot use the standard code in the `inDimension` function for this purpose since it is bugged
  * with the Death Certificate area.

package/functions/rooms.lua

@@ -67,9 +67,9 @@ local irange = ____utils.irange
 function ____exports.getRoomShapeNeighborGridIndexDeltas(self, roomShape)
     return {__TS__Spread(ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]:values())}
 end
---- Helper function to get the room descriptor for every room on the level. Uses the `Level.GetRooms`
--- method to accomplish this. Rooms without data are assumed to be non-existent and are not added to
--- the list.
+--- Helper function to get the room descriptor for every room on the level, including off-grid rooms.
+-- Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
+-- non-existent and are not added to the list.
 -- 
 -- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
 -- extra-dimensional rooms are automatically be generated and can be
@@ -209,6 +209,23 @@ end
 function ____exports.getRoomTypeName(self, roomType)
     return ROOM_TYPE_NAMES[roomType]
 end
+--- Helper function to get the room descriptor for every room on the level except for rooms that are
+-- not on the grid. Uses the `Level.GetRooms` method to accomplish this. Rooms without data are
+-- assumed to be non-existent and are not added to the list.
+-- 
+-- @param includeExtraDimensionalRooms Optional. On some floors (e.g. Downpour 2, Mines 2),
+-- extra-dimensional rooms are automatically be generated and can be
+-- seen when you iterate over the `RoomList`. Default is false.
+function ____exports.getRoomsInGrid(self, includeExtraDimensionalRooms)
+    if includeExtraDimensionalRooms == nil then
+        includeExtraDimensionalRooms = false
+    end
+    local rooms = ____exports.getRooms(nil, includeExtraDimensionalRooms)
+    return __TS__ArrayFilter(
+        rooms,
+        function(____, roomDescriptor) return roomDescriptor.SafeGridIndex >= 0 end
+    )
+end
 --- Helper function to get the room descriptor for every room on the level in a specific dimension.
 -- Uses the `Level.GetRooms` method to accomplish this. Rooms without data are assumed to be
 -- non-existent and are not added to the list.
@@ -253,10 +270,10 @@ function ____exports.inBossRoomOf(self, bossID)
     local roomSubType = getRoomSubType(nil)
     return roomType == RoomType.BOSS and roomStageID == StageID.SPECIAL_ROOMS and roomSubType == bossID
 end
---- Helper function for determining whether the current room is a crawlspace. Use this function over
+--- Helper function for determining whether the current room is a crawl space. Use this function over
 -- comparing to `RoomType.DUNGEON` or `GridRoom.DUNGEON_IDX` since there is a special case of the
 -- player being in a boss fight that take place in a dungeon.
-function ____exports.inCrawlspace(self)
+function ____exports.inCrawlSpace(self)
     local room = game:GetRoom()
     local roomType = room:GetType()
     local roomSubType = getRoomSubType(nil)
@@ -430,12 +447,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue67
+                goto __continue69
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue67::
+        ::__continue69::
     end
     sfxManager:Stop(SoundEffect.DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)

package/index.d.ts

@@ -77,6 +77,7 @@ export * from "./functions/log";
 export * from "./functions/map";
 export * from "./functions/math";
 export * from "./functions/mergeTests";
+export * from "./functions/minimap";
 export * from "./functions/nextStage";
 export * from "./functions/npc";
 export * from "./functions/pickups";

package/index.lua

@@ -612,6 +612,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.minimap")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.nextStage")
     for ____exportKey, ____exportValue in pairs(____export) do

package/objects/roomTypeNames.lua

@@ -19,7 +19,7 @@ ____exports.ROOM_TYPE_NAMES = {
     [RoomType.SACRIFICE] = "Sacrifice Room",
     [RoomType.DEVIL] = "Devil Room",
     [RoomType.ANGEL] = "Angel Room",
-    [RoomType.DUNGEON] = "Crawlspace",
+    [RoomType.DUNGEON] = "Crawl Space",
     [RoomType.BOSS_RUSH] = "Boss Rush",
     [RoomType.CLEAN_BEDROOM] = "Clean Bedroom",
     [RoomType.DIRTY_BEDROOM] = "Dirty Bedroom",

package/package.json

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