Dungeon API Reference

Namespace overview

Everything public lives in namespace DungeonGen:

DungeonManager

DungeonManager : MonoBehaviour plans a complete DungeonTemplate tree in pure math, then materializes it transactionally — previous output is only cleared after a successful plan. Exposed in the inspector as a Generate Dungeon button and as the context menu Generate Dungeon.

Methods

Key fields

Supporting types: DungeonGenerationMode (TemplateExact = 0, TemplateSequencedRandom = 1); RoomPlacementContext ([Flags]: Template, SequenceFiller, RandomBranch, All); RoomPoolEntry (struct with Allows(context)); RoomType (Normal, Entrance, Exit, Treasure, Boss).

ChunkDungeonStreamer

ChunkDungeonStreamer : MonoBehaviour is the scene-facing chunk streamer: it measures the assigned prefabs, plans a (2·plannedRadius+1)² neighborhood and materializes a (2·loadedRadius+1)² neighborhood around the player. The initial load settles synchronously so the player spawns into a ready world; later center changes are frame-sliced. Chunk instances pool on a sibling ChunkPool container, and unloaded chunk roots stay inactive for cheap revisits.

Methods

Key fields

Supporting chunk architecture

These types back the streamer and are part of the public DungeonGen namespace: ChunkStreamer (load/unload scheduling, Dispose(), LoadedCount, LastError), ChunkPlanner (deterministic chunk layouts, Plan(...), ChunkPlanResult, ChunkPlanStatus/ChunkPlanFailureKind), ChunkMaterializer (room and corridor instantiation), ChunkRoomProviderFactory (Measure(prefab, cellSize, out provider, out error)), ChunkGridSettings (chunk dimensions, room limits, streaming distance, IsValid(out error)), ChunkCoord (X, Z, Floor, Zero, ToKey()), ChunkKeyPickup, and ChunkRoomRequiresKey.

RoomDecorator

RoomDecorator fills a room from a DecorationProfile. The same solver runs in the editor preview and at runtime; runtime prefabs can use RoomDecorationAuthoring, which stores a baked geometry snapshot from the room design.

Constructors: RoomDecorator(RoomDesign design, Transform root, DecorationProfile profile, int seed) and RoomDecorator(IRoomGeometry geo, Transform root, DecorationProfile profile, int seed).

Result types: DecorationResult (placed, diagnostics, hasErrors, errorMessage), PlacedInstance (instance, categoryId, categoryName, worldPosition, worldRotation, footprint, boundsSize, padding, floor, gridX, gridY, prefab, occupancy), and GroupDiagnostic (targetCount, placedCount, candidateCount, solveMilliseconds, instantiateMilliseconds, groupDead, groupDeadReason, rejectionCounts).

Authoring enums: PlacementSurface, PlacementRegion, AmountMode, FailurePolicy, WallRegion, OccupancyMode, DistributionMode, OrientationMode, RelationType, FloorScope, and FitMode.

Rendering & room geometry

IDungeonRenderer

The default implementation is PrefabDungeonRenderer. Implement or wrap IDungeonRenderer to swap the rendering backend.

IRoomGeometry

Geometry contract for the decorator, implemented by RoomDesign (editor) and RoomDecorationAuthoring (runtime baked snapshot); RoomDesignGeometry is the adapter struct. Members: Width, Height, FloorIndices (IReadOnlyList<int>), TileSize, FloorHeight, WallThickness, CenterPivot; TileType[] GetFloor(int floor), InBounds(x, y), IsWallAt(x, y, floor), HasDoorAt(x, y, floor), IsStairFloorOpeningAt(x, y, floor), IsStairCeilingOpeningAt(x, y, floor), IsInStairFootprint(StairPlacement, x, y), Doors, and Stairs.

Post-processing & culling

Post-processing contracts

• IDungeonPostProcessor — int Priority { get; } and void Process(DungeonPostProcessContext context). DungeonManager runs every enabled processor on its GameObject after materialization, wiring, progression, and decoration; higher Priority first, stable on ties.
• DungeonPostProcessor — abstract MonoBehaviour carrier with a serialized priority, so processors can be added as components without code.
• DungeonPostProcessContext — read-only per-run snapshot: RunSeed, Root, Rooms, LayoutRooms, Connections; valid for the duration of Process.
• IDungeonPreClearProcessor — void BeforeClear(), invoked at the start of the manager's clear so processors can release references to rooms that are about to be destroyed (for example a baked NavMesh).

DungeonNavMeshPostProcessor

Implements both post-processor contracts and bakes one whole-dungeon NavMesh per generation. Key fields: agentTypeID, buildOnProcess, useDoorLinks, bakeConnectors, logErrors. Requires DungeonNavMeshSurfaceHost (auto-added with the surface).

DungeonCulling and rules

DungeonCulling is an additive portal-culling post-processor: it reads the generated room graph and socket state and only toggles renderer/activation state — removing the component restores the exact unculled behavior. Mode: DungeonCullingMode (Disabled, DisableRenderers, DeactivateRooms). Key members: Refresh(), PollNow(), IsRoomVisible(RoomData), SetConnectionRule(ICullConnectionRule), AddRoomRule(ICullRoomRule), RemoveRoomRule(ICullRoomRule), SetReference(Transform), plus toggles such as UseDoorState, UseMaxHops, UseOcclusionTolerance, UseDistanceCulling, UseVisibleRoomBudget, MaxHops, and MaxVisibleRooms.

Authoring ScriptableObjects

All assets are created via Assets ▸ Create ▸ DungeonGen ▸ …:

Progression contracts

• IItemSpawnPoint — bool CanSpawn(ProgressionRequirement requirement) and bool TrySpawn(ItemSpawnRequest request). Default MonoBehaviour implementation: ItemSpawnPoint (optional target and prefab override).
• ItemSpawnRequest — readonly struct (requirement, roomRoot).
• ProgressionItemToken — MonoBehaviour stamped on spawned items (Requirement, Configure(requirement)).
• IConnectionGate — ProgressionRequirement Requirement, bool IsLocked, CanHandle(requirement), Configure(requirement), Unlock(). Default implementation: BasicConnectionGate.

ProgressionRequirement assets gate template edges; a gate holds the connection until the requirement is fulfilled, and item spawn points place the items that fulfill it.

Supporting core types

See also Dungeon Quick Start for the practical flow and Dungeon Generator Overview for the authoring/assembly model.