Dungeon Architect  17.0.0
DungeonArchitect.Dungeon Class Reference

The main dungeon behavior that manages the creation and destruction of dungeons More...

Inheritance diagram for DungeonArchitect.Dungeon:

Public Member Functions

List< DungeonThemeDataGetThemeAssets ()
 
void Build ()
 Builds the complete dungeon (layout and visual phase) More...
 
void Build (IDungeonSceneObjectInstantiator objectInstantiator)
 
void ReapplyTheme (IDungeonSceneObjectInstantiator objectInstantiator)
 Runs the theming engine over the existing layout to rebuild the game objects from the theme file.
The layout is not built in this stage More...
 
void DestroyDungeon ()
 Destroys the dungeon More...
 
void RequestRebuild ()
 Requests the dungeon to be rebuilt in the next update phase More...
 
virtual void Update ()
 
void AddPaintCell (IntVector location, bool automaticRebuild)
 
void AddPaintCell (IntVector location, bool automaticRebuild, IDungeonSceneObjectInstantiator sceneInstantiator)
 Registers a painted cell More...
 
void RemovePaintCell (IntVector location, bool automaticRebuild)
 Remove a previous painted cell More...
 
void RemovePaintCell (IntVector location, bool automaticRebuild, IDungeonSceneObjectInstantiator sceneInstantiator)
 Remove a previous painted cell More...
 
void ClearToolOverlayData (bool automaticRebuild)
 Clears all overlay data More...
 

Public Attributes

List< GraphdungeonThemes
 List of themes assigned to this dungeon More...
 
bool debugDraw = false
 Draw debug data More...
 

Properties

DungeonModel ActiveModel [get]
 Active model used by the dungeon More...
 
bool IsLayoutBuilt [get]
 Flag to check if the layout has been built.
This is used to quickly reapply the theme after the theme graph has been modified, without rebuilding the layout, if it has already been built More...
 
LevelMarkerList Markers [get]
 
DungeonConfig Config [get]
 

Detailed Description

The main dungeon behavior that manages the creation and destruction of dungeons

Definition at line 16 of file Dungeon.cs.

Member Function Documentation

◆ AddPaintCell()

void DungeonArchitect.Dungeon.AddPaintCell ( IntVector  location,
bool  automaticRebuild,
IDungeonSceneObjectInstantiator  sceneInstantiator 
)

Registers a painted cell

Parameters
locationthe location of the painted cell, in grid cooridnates
automaticRebuildif true, the dungeon would be rebuilt, if the data model has changed due to this request

Definition at line 387 of file Dungeon.cs.

◆ Build()

void DungeonArchitect.Dungeon.Build ( )

Builds the complete dungeon (layout and visual phase)

Definition at line 121 of file Dungeon.cs.

◆ ClearToolOverlayData()

void DungeonArchitect.Dungeon.ClearToolOverlayData ( bool  automaticRebuild)

Clears all overlay data

Parameters
automaticRebuild

Definition at line 449 of file Dungeon.cs.

◆ DestroyDungeon()

void DungeonArchitect.Dungeon.DestroyDungeon ( )

Destroys the dungeon

Definition at line 289 of file Dungeon.cs.

◆ ReapplyTheme()

void DungeonArchitect.Dungeon.ReapplyTheme ( IDungeonSceneObjectInstantiator  objectInstantiator)

Runs the theming engine over the existing layout to rebuild the game objects from the theme file.
The layout is not built in this stage

Definition at line 165 of file Dungeon.cs.

◆ RemovePaintCell() [1/2]

void DungeonArchitect.Dungeon.RemovePaintCell ( IntVector  location,
bool  automaticRebuild 
)

Remove a previous painted cell

Parameters
locationthe location of the painted cell to remove, in grid cooridnates
automaticRebuildif true, the dungeon would be rebuilt, if the data model has changed due to this request

Definition at line 421 of file Dungeon.cs.

◆ RemovePaintCell() [2/2]

void DungeonArchitect.Dungeon.RemovePaintCell ( IntVector  location,
bool  automaticRebuild,
IDungeonSceneObjectInstantiator  sceneInstantiator 
)

Remove a previous painted cell

Parameters
locationthe location of the painted cell to remove, in grid cooridnates
automaticRebuildif true, the dungeon would be rebuilt, if the data model has changed due to this request

Definition at line 431 of file Dungeon.cs.

◆ RequestRebuild()

void DungeonArchitect.Dungeon.RequestRebuild ( )

Requests the dungeon to be rebuilt in the next update phase

Definition at line 336 of file Dungeon.cs.

Member Data Documentation

◆ debugDraw

bool DungeonArchitect.Dungeon.debugDraw = false

Draw debug data

Definition at line 25 of file Dungeon.cs.

◆ dungeonThemes

List<Graph> DungeonArchitect.Dungeon.dungeonThemes

List of themes assigned to this dungeon

Definition at line 20 of file Dungeon.cs.

Property Documentation

◆ ActiveModel

DungeonModel DungeonArchitect.Dungeon.ActiveModel
get

Active model used by the dungeon

Definition at line 36 of file Dungeon.cs.

◆ IsLayoutBuilt

bool DungeonArchitect.Dungeon.IsLayoutBuilt
get

Flag to check if the layout has been built.
This is used to quickly reapply the theme after the theme graph has been modified, without rebuilding the layout, if it has already been built

Definition at line 50 of file Dungeon.cs.


The documentation for this class was generated from the following file: