isaacscript-common 4.3.2 → 4.5.0

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

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.
@@ -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/functions/stage.d.ts

@@ -36,6 +36,16 @@ export declare function onDarkRoom(): boolean;
 export declare function onFinalFloor(): boolean;
 export declare function onRepentanceStage(): boolean;
 export declare function onSheol(): boolean;
+/**
+ * Helper function to warp to a new stage/level.
+ *
+ * @param stage The stage number to warp to.
+ * @param stageType The stage type to warp to.
+ * @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
+ *               this to true if you are warping to the same stage but a different stage type (or
+ *               else the floor layout will be identical to the old floor).
+ */
+export declare function setStage(stage: LevelStage, stageType: StageType, reseed?: boolean): void;
 /**
  * Helper function to convert a numerical `StageType` into the letter suffix supplied to the "stage"
  * console command. For example, `StageType.REPENTANCE` is the stage type for Downpour, and the

package/functions/stage.lua

@@ -4,6 +4,8 @@ local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____stageTypeSuffixes = require("objects.stageTypeSuffixes")
+local STAGE_TYPE_SUFFIXES = ____stageTypeSuffixes.STAGE_TYPE_SUFFIXES
 local ____stageTypeToLetter = require("objects.stageTypeToLetter")
 local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
 function ____exports.isRepentanceStage(self, stageType)
@@ -111,4 +113,22 @@ function ____exports.onSheol(self)
     local stageType = level:GetStageType()
     return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.ORIGINAL
 end
+--- Helper function to warp to a new stage/level.
+-- 
+-- @param stage The stage number to warp to.
+-- @param stageType The stage type to warp to.
+-- @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
+-- this to true if you are warping to the same stage but a different stage type (or
+-- else the floor layout will be identical to the old floor).
+function ____exports.setStage(self, stage, stageType, reseed)
+    if reseed == nil then
+        reseed = false
+    end
+    local stageTypeSuffix = STAGE_TYPE_SUFFIXES[stageType]
+    local command = ("stage " .. tostring(stage)) .. stageTypeSuffix
+    Isaac.ExecuteCommand(command)
+    if reseed then
+        Isaac.ExecuteCommand("reseed")
+    end
+end
 return ____exports

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/stageTypeSuffixes.d.ts

@@ -0,0 +1,4 @@
+import { StageType } from "isaac-typescript-definitions";
+export declare const STAGE_TYPE_SUFFIXES: {
+    readonly [key in StageType]: string;
+};

package/objects/stageTypeSuffixes.lua

@@ -0,0 +1,12 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
+____exports.STAGE_TYPE_SUFFIXES = {
+    [StageType.ORIGINAL] = "",
+    [StageType.WRATH_OF_THE_LAMB] = "a",
+    [StageType.AFTERBIRTH] = "b",
+    [StageType.GREED_MODE] = "",
+    [StageType.REPENTANCE] = "c",
+    [StageType.REPENTANCE_B] = "d"
+}
+return ____exports

package/package.json

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