The heart of the localisation system. Every localisation, its serialisation and editing is managed here.

Public Member Functions
void	AddLocalisation (LocalisationID localisationID, Dictionary< LocalisationLanguage, string > localisations)
	Adds a new localisation to the system.

void	AddScope (string scopeName)
	Adds a new LocalisationScope to the system.

void	AddLanguage (string languageName, string languageShortName)
	Adds a new LocalisationLanguage to the system.

void	RemoveLanguage (LocalisationLanguage language)
	Removes a LocalisationLanguage from the system.

void	RemoveScope (LocalisationScope scope)
	Removes a LocalisationScope from the system.

void	RemoveLocalisation (LocalisationID localisationID)
	Removes a localisation, that is a LocalisationID with all its content, from the system.

void	EditLocalisationID (LocalisationID oldID, LocalisationID newID)
	Edits an existing LocalisationID by replacing the IDs, but keeping its content.

void	EditScope (LocalisationScope oldScope, string newScopeName)
	Replaces a LocalisationScope with a new one for all available data.

void	EditLanguage (LocalisationLanguage oldLanguage, string newLanguageName, string newLanguageShortName)
	Replaces a LocalisationLanguage with a new one for all available data.

void	EditLocalisation (LocalisationID localisationID, Dictionary< LocalisationLanguage, string > localisations)
	Edits a given localisation found by the LocalisationID by replacing the current content with localisations .

void	WriteData ()
	Writes the data to disk. For this to work, a valid path within the project must be setup.

void	Initialize ()
	Initializes the Localizer. This is required due to its dependency on a valid path.

Properties
static Localizer	Instance `[get]`

Dictionary< LocalisationID, Dictionary< LocalisationLanguage, string > >	LocalisationData `[get]`

HashSet< LocalisationLanguage >	LocalisationLanguages `[get]`

HashSet< LocalisationScope >	LocalisationScopes `[get]`

LocalisationScope	DefaultScope `[get]`

bool	IsInitialized `[get]`

Events
Action< LocalisationScope >	ScopeEdited

Action< LocalisationLanguage >	LanguageEdited

Action< LocalisationID >	LocalisationIDEdited

Member Function Documentation

◆ AddLanguage()

void UnityToolbox.UI.Localisation.Localizer.AddLanguage	(	string	languageName,
		string	languageShortName
	)

Parameters

languageName
languageShortName

Exceptions

LocalisationException

References UnityToolbox.UI.Localisation.Localizer.Initialize().

◆ AddLocalisation()

void UnityToolbox.UI.Localisation.Localizer.AddLocalisation	(	LocalisationID	localisationID,
		Dictionary< LocalisationLanguage, string >	localisations
	)

Parameters

localisationID
localisations

Exceptions

LocalisationException

References UnityToolbox.UI.Localisation.Localizer.Initialize(), and UnityToolbox.UI.Localisation.LocalisationLanguage.Name.

◆ AddScope()

void UnityToolbox.UI.Localisation.Localizer.AddScope ( string scopeName )

Parameters

scopeName

Exceptions

LocalisationException

References UnityToolbox.UI.Localisation.LocalisationScope.Equals(), and UnityToolbox.UI.Localisation.Localizer.Initialize().

◆ EditLanguage()

void UnityToolbox.UI.Localisation.Localizer.EditLanguage	(	LocalisationLanguage	oldLanguage,
		string	newLanguageName,
		string	newLanguageShortName
	)

Parameters

oldLanguage
newLanguageName
newLanguageShortName

Exceptions

LocalisationException

References UnityToolbox.UI.Localisation.Localizer.Initialize().

Referenced by UnityToolbox.UI.Localisation.Editor.LocalisationEditLanguageWindow.OnGUI().

◆ EditLocalisation()

void UnityToolbox.UI.Localisation.Localizer.EditLocalisation	(	LocalisationID	localisationID,
		Dictionary< LocalisationLanguage, string >	localisations
	)