PixelCrushers.DialogueSystem.DatabaseManager Class Reference

Manages a master DialogueDatabase and associated Lua environment. More...

Public Member Functions

 DatabaseManager (DialogueDatabase defaultDatabase=null)
 Initializes a new DatabaseManager. More...
 
void Add (DialogueDatabase database)
 Adds a database to the master database, and updates the Lua environment. More...
 
void Remove (DialogueDatabase database)
 Removes a database from the master database, and updates the Lua environment. More...
 
void Clear ()
 Removes all loaded databases from the master database and clears the Lua environment. More...
 
void Reset (DatabaseResetOptions databaseResetOptions=DatabaseResetOptions.RevertToDefault)
 Resets the master database using the specified DatabaseResetOptions. More...
 

Properties

DialogueDatabase DefaultDatabase [get, set]
 Gets or sets the default database. More...
 
DialogueDatabase MasterDatabase [get]
 Gets the master database. More...
 

Detailed Description

Manages a master DialogueDatabase and associated Lua environment.

Constructor & Destructor Documentation

◆ DatabaseManager()

PixelCrushers.DialogueSystem.DatabaseManager.DatabaseManager ( DialogueDatabase  defaultDatabase = null)

Initializes a new DatabaseManager.

Loading of the default database is delayed until the first time the database is accessed. If you want to manually load the database, you can reset it or add a database to it.

Parameters
defaultDatabase(Optional) The default database.

Member Function Documentation

◆ Add()

void PixelCrushers.DialogueSystem.DatabaseManager.Add ( DialogueDatabase  database)

Adds a database to the master database, and updates the Lua environment.

Parameters
databaseThe database to add.

◆ Clear()

void PixelCrushers.DialogueSystem.DatabaseManager.Clear ( )

Removes all loaded databases from the master database and clears the Lua environment.

◆ Remove()

void PixelCrushers.DialogueSystem.DatabaseManager.Remove ( DialogueDatabase  database)

Removes a database from the master database, and updates the Lua environment.

Does not remove any assets that are also defined in other loaded databases.

Parameters
databaseThe database to remove.

◆ Reset()

void PixelCrushers.DialogueSystem.DatabaseManager.Reset ( DatabaseResetOptions  databaseResetOptions = DatabaseResetOptions.RevertToDefault)

Resets the master database using the specified DatabaseResetOptions.

Parameters
databaseResetOptionsDatabase reset options.

Property Documentation

◆ DefaultDatabase

DialogueDatabase PixelCrushers.DialogueSystem.DatabaseManager.DefaultDatabase
getset

Gets or sets the default database.

The default database to use at startup or when resetting the database manager.

◆ MasterDatabase

DialogueDatabase PixelCrushers.DialogueSystem.DatabaseManager.MasterDatabase
get

Gets the master database.

The master database.


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