EasyTalk API
Loading...
Searching...
No Matches
EasyTalk.Settings.DialogueRegistry Class Reference

The DialogueRegistry class is used for store and configure information which may be used across dialogue assets and in the editor, such as global variables and character libraries. More...

Inheritance diagram for EasyTalk.Settings.DialogueRegistry:

Public Member Functions

int FindVariable (string varName)
 Finds and returns the index of the global variable with the specified name, if it exists.
 

Properties

CharacterLibrary CharacterLibrary [get, set]
 Gets or sets the character library to use.
 
List< GlobalNodeVariableGlobalVariables [get, set]
 Gets or sets the List of global variables to use.
 
List< NodeTypeTranslatedNodeTypes [get, set]
 Gets or sets the list of node types which are allowed to be translated.
 
bool UseSingleTranslationLibrary [get, set]
 Gets or sets whether a single translation library should be used, rather than the translation library of an individual dialogue.
 
TranslationLibrary TranslationLibrary [get, set]
 Gets or sets the translation library to use when the registry is set to use a single translation library.
 

Private Attributes

CharacterLibrary characterLibrary
 The character library used by the registry.
 
List< GlobalNodeVariablevariables = new List<GlobalNodeVariable>()
 The List of global variables defined in the registry.
 
List< NodeTypetranslatedNodeTypes = new List<NodeType>() { NodeType.CONVO, NodeType.OPTION, NodeType.APPEND }
 Defines a list of node types which are allowed to be translated.
 
bool useSingleTranslationLibrary = false
 Whether or not a single translation library should be used rather than each dialogue asset's specific library.
 
TranslationLibrary translationLibrary = null
 The translation library to use when using a single library to perform translations.
 

Detailed Description

The DialogueRegistry class is used for store and configure information which may be used across dialogue assets and in the editor, such as global variables and character libraries.

Member Function Documentation

◆ FindVariable()

int EasyTalk.Settings.DialogueRegistry.FindVariable ( string varName)

Finds and returns the index of the global variable with the specified name, if it exists.

Parameters
varNameThe name of the variable to retrieve.
Returns
The index of the specified global variable within the registry's global variable list. If the variable can't be found, this method returns -1.

Member Data Documentation

◆ characterLibrary

CharacterLibrary EasyTalk.Settings.DialogueRegistry.characterLibrary
private

The character library used by the registry.

◆ translatedNodeTypes

List<NodeType> EasyTalk.Settings.DialogueRegistry.translatedNodeTypes = new List<NodeType>() { NodeType.CONVO, NodeType.OPTION, NodeType.APPEND }
private

Defines a list of node types which are allowed to be translated.

◆ translationLibrary

TranslationLibrary EasyTalk.Settings.DialogueRegistry.translationLibrary = null
private

The translation library to use when using a single library to perform translations.

◆ useSingleTranslationLibrary

bool EasyTalk.Settings.DialogueRegistry.useSingleTranslationLibrary = false
private

Whether or not a single translation library should be used rather than each dialogue asset's specific library.

◆ variables

List<GlobalNodeVariable> EasyTalk.Settings.DialogueRegistry.variables = new List<GlobalNodeVariable>()
private

The List of global variables defined in the registry.

Property Documentation

◆ CharacterLibrary

CharacterLibrary EasyTalk.Settings.DialogueRegistry.CharacterLibrary
getset

Gets or sets the character library to use.

◆ GlobalVariables

List<GlobalNodeVariable> EasyTalk.Settings.DialogueRegistry.GlobalVariables
getset

Gets or sets the List of global variables to use.

◆ TranslatedNodeTypes

List<NodeType> EasyTalk.Settings.DialogueRegistry.TranslatedNodeTypes
getset

Gets or sets the list of node types which are allowed to be translated.

◆ TranslationLibrary

TranslationLibrary EasyTalk.Settings.DialogueRegistry.TranslationLibrary
getset

Gets or sets the translation library to use when the registry is set to use a single translation library.

◆ UseSingleTranslationLibrary

bool EasyTalk.Settings.DialogueRegistry.UseSingleTranslationLibrary
getset

Gets or sets whether a single translation library should be used, rather than the translation library of an individual dialogue.