Class "Level"

Functions

CanPlaceRoom ()

boolean CanPlaceRoom ( RoomConfigRoom RoomConfigToPlace, int GridIndex, Dimension Dimension = -1, bool AllowMultipleDoors = true, bool AllowSpecialNeighbors = false, bool AllowNoNeighbors = false )

Returns true if the provided room could be successfully placed at this location using TryPlaceRoom. See documentation for TryPlaceRoom for more information.

CanPlaceRoomAtDoor ()

boolean CanPlaceRoomAtDoor ( RoomConfigRoom RoomConfigToPlace, RoomDescriptor NeighborRoomDescriptor, DoorSlot DoorSlot, bool AllowMultipleDoors = true, bool AllowSpecialNeighbors = false )

See documentation for TryPlaceRoomAtDoor and TryPlaceRoom for more information. Returns true if the provided room (the RoomConfigRoom) could be successfully placed as a neighbor of an existing room (the RoomDescriptor) at the specified DoorSlot, using TryPlaceRoomAtDoor.

CanSpawnDoorOutline ()

boolean CanSpawnDoorOutline ( int RoomIdx, DoorSlot DoorSlot )

---

FindValidRoomPlacementLocations ()

int[] FindValidRoomPlacementLocations ( RoomConfigRoom RoomConfig, Dimension Dimension = -1, bool AllowMultipleDoors = true, bool AllowSpecialNeighbors = false )

See TryPlaceRoom for more information on room placement and example code. Returns a table of room grid indices that would be valid locations to place the specified room using TryPlaceRoom. Note that if you set AllowSpecialNeighbors to true, you can get weird placements next to the ultra secret room. You can use GetNeighboringRooms to confirm that potential neighbors are desired before placing your room.

GetDimension ()

Dimension GetDimension ( )

Get's the current Dimension the player is in.

GetForceSpecialQuest ()

SpecialQuest GetForceSpecialQuest ( )

If set, the level will automatically attempt to place the Knife Piece puzzle door for this LevelStage.

Info

This is set to SpecialQuest.DEFAULT immediately before calling MC_PRE_LEVEL_INIT.

GetGreedWavesClearedWithoutRedHeartDamage ()

int GetGreedWavesClearedWithoutRedHeartDamage ( )

---

GetMyosotisPickups ()

EntitiesSaveStateVector GetMyosotisPickups ( )

Returns the pickups that will be transferred to the next floor by the Myosotis trinket effect.

GetNeighboringRooms ()

table GetNeighboringRooms ( int GridIndex, RoomShape, Dimension Dimension = -1 )

If you want to get the neighbors of an existing room, you can simply use RoomDescriptor:GetNeighboringRooms() instead. if roomType == RoomType.ROOM_SECRET or roomType == RoomType.ROOM_SUPERSECRET or roomType == RoomType.ROOM_ULTRASECRET then Returns a table that maps DoorSlot to RoomDescriptor for all of the neighbors that a room of the specified shape would have if placed at this location. return false Note that this does not give you any information on if a room would actually fit here, or if the neighbors would even allow the connection. for doorSlot, neighborDesc in pairs(Game():GetLevel():GetNeighboringRooms(gridIndex, roomShape)) do end Don't use ipairs to iterate over this, use pairs!

local roomType = neighborDesc.Data.Type
return true
-- Returns true if a room placed at this GridIndex with this RoomShape would have a neighboring secret room.
???- example "Example Code"
local function WouldHaveSecretRoomNeighbor(gridIndex, roomShape)

HasAbandonedMineshaft ()

boolean HasAbandonedMineshaft ( )

Returns true if the floor has the mineshaft room used for the second Knife Piece puzzle.

HasMirrorDimension ()

boolean HasMirrorDimension ( )

Returns true if the floor has the mirror dimension used for the first Knife Piece puzzle.

HasPhotoDoor ()

boolean HasPhotoDoor ( )

Returns true if the floor has the photo door used to enter Mausoleum/Gehenna leading to the Ascent sequence.

IsStageAvailable ()

void IsStageAvailable ( LevelStage Level, StageType Stage )

Returns true if the provided Level and Stage combination is available to be generated in any given run. Returns false if locked behind an achievement.

PlaceRoom ()

boolean PlaceRoom ( LevelGeneratorEntry Room, RoomConfigRoom RoomConfig, int Seed )

Places a room into the game. Returns true if successful. See TryPlaceRoom and related functions if you want to properly add new rooms to the floor after level generation, similarly to what Red Key does. Note that this function does not really check if a room placement would be considered valid, nor does it create the doors necessary to connect the new room to its neighbors.

SetForceSpecialQuest ()

void SetForceSpecialQuest ( SpecialQuest Quest )

Sets whether the level should attempt to place the Knife Piece puzzle door for this LevelStage.

Info

This is set to SpecialQuest.DEFAULT immediately before calling MC_PRE_LEVEL_INIT.

SetGreedWavesClearedWithoutRedHeartDamage ()

void SetGreedWavesClearedWithoutRedHeartDamage ( int WavesCleared )

---

SetName ()

void SetName ( string Name )

---

TryPlaceRoom ()

RoomDescriptor TryPlaceRoom ( RoomConfigRoom RoomConfigToPlace, int GridIndex, Dimension Dimension = -1, int Seed = 0, bool AllowMultipleDoors = true, bool AllowSpecialNeighbors = false, bool AllowNoNeighbors = false )

-- Try to place the room. Attempts to place the provided room at the specified location.

local level = game:GetLevel()
???- example "Example Code"
local room = level:TryPlaceRoom(roomConfig, gridIndex, dimension, seed, allowMultipleDoors, allowSpecialNeighbors)
local options = level:FindValidRoomPlacementLocations(roomConfig, dimension, allowMultipleDoors, allowSpecialNeighbors)
if room then
if not connectsToStartingRoom then
-- and otherwise just place the room at the first place we check.
local neighbors = level:GetNeighboringRooms(gridIndex, roomConfig.Shape)
local dimension = -1  -- current dimension
local seed = level:GetDungeonPlacementSeed()
-- Fetch a random RoomConfig for a new treasure room.
-- You may have additional conditions or priorities when it comes to where you would prefer to place your room.
-- Disallow placements with multiple doors, or placements that connect to other special rooms.
return
local allowSpecialNeighbors = false
local function AddAnotherTreasureRoomToTheFloorAtARandomValidLocation()
end
-- The room was placed successfully!
-- Fetch all valid locations.
-- Adds another treasure room to the floor at a random valid location.
This function will ONLY place the room if it fits (does not overlap any other existing rooms, and can mutually connect to all neighboring room with doors).
The boolean parameters enable or disable additional restrictions/safeties for room placement:
-- For the purposes of this example we arbitarily forbid the new room from being connected to the starting room,
for doorSlot, neighborDesc in pairs(neighbors) do
If successful, returns the newly initialized [RoomDescriptor](https://wofsauge.github.io/IsaacDocs/rep/RoomDescriptor.html). Otherwise, returns nil.
for _, gridIndex in pairs(options) do
local roomConfig = RoomConfigHolder.GetRandomRoom(seed, true, StbType.SPECIAL_ROOMS, RoomType.ROOM_TREASURE, RoomShape.ROOMSHAPE_1x1)
local allowMultipleDoors = false
local connectsToStartingRoom = false
- AllowNoNeighbors: Set to `true` to permit room placements out in the void with no neighbors at all.
If a seed of 0 or nil is provided, a deterministic seed with be auto-generated based on the location, room shape, and level seed.
- AllowMultipleDoors: Set to `false` to only allow placement if the room would only have one door (useful for placing special rooms). Secret rooms don't count as a door.
if neighborDesc.GridIndex == level:GetStartingRoomIndex() then
- AllowSpecialNeighbors: Set to `true` to allow connections to existing special rooms (note that secret rooms are always permitted, but boss rooms never are).
connectsToStartingRoom = true
-- Get the RoomDescriptors of all rooms that would be neighboring the room if placed here.

TryPlaceRoomAtDoor ()

RoomDescriptor TryPlaceRoomAtDoor ( RoomConfigRoom RoomConfigToPlace, RoomDescriptor NeighborRoomDescriptor, DoorSlot DoorSlot, int Seed = 0, bool AllowMultipleDoors = true, bool AllowSpecialNeighbors = false )

local room = game:GetRoom() success = true local newRoom = level:TryPlaceRoomAtDoor(roomConfig, roomDesc, doorSlot, seed, true, false) -- Bitmask check to identify if the current room would even allow a door to be placed here. if newRoom then return {ShowAnim=true}

local level = game:GetLevel()
for doorSlot=0, 7 do
local seed = rng:Next()
???- example "Example Code"
mod:AddCallback(ModCallbacks.MC_USE_ITEM, function(_, id, rng, player, flags, slot)
end, MY_ACTIVE_ITEM_ID)
if roomConfig then
-- Example code for an active item that creates a new 1x1 room at every doorslot available in the current room.
local success = false
if doorSlotAllowed and not room:GetDoor(doorSlot) then
return {Discharge=false}
if success then
local requiredDoors = 15  -- Bitmask value that requires the new 1x1 room to have all 4 doorslots available, just so we're sure it fits.
else
end
Otherwise, the details are the same as for [TryPlaceRoom](Level.md#tryplaceroom).
local doorSlotAllowed = roomDesc.Data.Doors & (1 << doorSlot) ~= 0
local roomDesc = level:GetCurrentRoomDesc()
local roomConfig = RoomConfigHolder.GetRandomRoom(seed, true, Isaac.GetCurrentStageConfigId(), RoomType.ROOM_DEFAULT, RoomShape.ROOMSHAPE_1x1, nil, nil, nil, nil, requiredDoors)
Similar to [TryPlaceRoom](Level.md#tryplaceroom), but attempts to place the provided room (the [RoomConfigRoom](https://wofsauge.github.io/IsaacDocs/rep/RoomConfig_Room.html)) as a neighbor of an existing room (the [RoomDescriptor](https://wofsauge.github.io/IsaacDocs/rep/RoomDescriptor.html)) at the specified [DoorSlot](https://wofsauge.github.io/IsaacDocs/rep/enums/DoorSlot.html).