PixelCrushers.DialogueSystem.Wrappers.DialogueDatabase Class Reference

This wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class. More...

Inheritance diagram for PixelCrushers.DialogueSystem.Wrappers.DialogueDatabase:
Collaboration diagram for PixelCrushers.DialogueSystem.Wrappers.DialogueDatabase:

Additional Inherited Members

- Public Member Functions inherited from PixelCrushers.DialogueSystem.DialogueDatabase
void ResetEmphasisSettings ()
 
bool IsPlayerID (int actorID)
 Determines whether an actor is a player character.
 
bool IsPlayer (string actorName)
 Determines whether an actor is a player character.
 
CharacterType GetCharacterType (int actorID)
 Gets the type of the character (PC or NPC) of an actor based on the actor's IsPlayer value.
 
void ResetCache ()
 Dialogue databases maintain a quick lookup cache of assets by Name (by Title for conversations).
 
delegate string GetCustomEntrytagDelegate (Conversation conversation, DialogueEntry entry)
 
Actor GetActor (string actorName)
 Gets the actor by name.
 
Actor GetActor (int id)
 Gets the actor associated with an actor ID.
 
Item GetItem (string itemName)
 Gets the item by name.
 
Item GetItem (int id)
 Gets the item associated with an item ID.
 
Location GetLocation (string locationName)
 Gets the location by name.
 
Location GetLocation (int id)
 Gets the location associated with a location ID.
 
Variable GetVariable (string variableName)
 Gets the variable by name.
 
Variable GetVariable (int id)
 Gets the variable by ID.
 
void AddConversation (Conversation conversation)
 Adds a Conversation to the database.
 
Conversation GetConversation (string conversationTitle)
 Retrieves a Conversation by its Title field.
 
Conversation GetConversation (int conversationID)
 Retrieves a Conversation by its ID.
 
DialogueEntry GetDialogueEntry (int conversationID, int dialogueEntryID)
 Gets a dialogue entry by its conversation and dialogue entry IDs.
 
DialogueEntry GetDialogueEntry (Link link)
 Follows a Link and returns the destination DialogueEntry.
 
string GetLinkText (Link link)
 Gets the text of the dialogue entry that a link points to.
 
void Add (DialogueDatabase database)
 Add the contents of another database to this database.
 
void Remove (DialogueDatabase database)
 Removes from this database all content that's in the specified database.
 
void Remove (DialogueDatabase database, List< DialogueDatabase > keep)
 Removes from this database all content that's in the specified database.
 
void Clear ()
 Removes all assets from this database.
 
void SyncAll ()
 Syncs all assets from their source databases if assigned in syncInfo.
 
void SyncActors ()
 Syncs the actors from syncInfo.syncActorsDatabase.
 
void SyncItems ()
 Syncs the items from syncInfo.syncItemsDatabase.
 
void SyncLocations ()
 Syncs the locations from syncInfo.syncLocationsDatabase.
 
void SyncVariables ()
 Syncs the variables from syncInfo.syncVariablesDatabase.
 
string GetEntrytag (Conversation conversation, DialogueEntry entry, EntrytagFormat entrytagFormat)
 Gets the entrytag string of a dialogue entry.
 
string GetEntrytag (int conversationID, int dialogueEntryID, EntrytagFormat entrytagFormat)
 Gets the entrytag string of a dialogue entry.
 
string GetEntrytaglocal (Conversation conversation, DialogueEntry entry, EntrytagFormat entrytagFormat)
 Gets the entrytaglocal string (localized version) of a dialogue entry.
 
string GetEntrytaglocal (int conversationID, int dialogueEntryID, EntrytagFormat entrytagFormat)
 Gets the entrytaglocal string (localized version) of a dialogue entry.
 
- Static Public Member Functions inherited from PixelCrushers.DialogueSystem.DialogueDatabase
static bool ContainsName< T > (List< T > assetList, string assetName)
 Checks if a list of assets contains an asset with a specified name.
 
static bool ContainsID< T > (List< T > assetList, int assetID)
 Checks if a list of assets contains an asset with a specified ID.
 
static bool ContainsTitle (List< Conversation > conversations, string title)
 Checks is a list of conversations contains a conversation with a specified title.
 
static bool Contains (DialogueDatabase database, Asset asset)
 Checks if a database contains an asset.
 
static bool Contains (List< DialogueDatabase > databaseList, Asset asset)
 Checks if a list of databases contains an asset.
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.DialogueDatabase
string version
 The version of the database, typically only used internally by the developer.
 
string author
 The author, typically only used internally by the developer.
 
string description
 The description of the database, typically only used internally by the developer.
 
string globalUserScript
 The global Lua user script.
 
EmphasisSetting[] emphasisSettings = new EmphasisSetting[NumEmphasisSettings]
 A Chat Mapper project defines four emphasis settings (text styles) for formatting lines of dialogue.
 
int baseID = 1
 Assign IDs of assets (actors, items, conversations, etc.) from this base value.
 
List< Actoractors = new List<Actor>()
 The actors in the database.
 
List< Itemitems = new List<Item>()
 The items in the database.
 
List< Locationlocations = new List<Location>()
 The locations in the database.
 
List< Variablevariables = new List<Variable>()
 The variables in the database.
 
List< Conversationconversations = new List<Conversation>()
 The conversations in the database.
 
SyncInfo syncInfo = new SyncInfo()
 
string templateJson = string.Empty
 Each database now stores a copy of its template.
 
- Static Public Attributes inherited from PixelCrushers.DialogueSystem.DialogueDatabase
const int NumEmphasisSettings = 4
 The number of emphasis settings supported by Chat Mapper and the Dialogue System.
 
static GetCustomEntrytagDelegate getCustomEntrytag = null
 
const string InvalidEntrytag = "invalid_entrytag"
 
const string VoiceOverFileFieldName = DialogueSystemFields.VoiceOverFile
 
- Properties inherited from PixelCrushers.DialogueSystem.DialogueDatabase
int playerID [get]
 Gets the ID of the first player character in the actor list.
 

Detailed Description

This wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class.


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