C# Class NaturalResourcesBrush.TranslationFramework.Translation

Handles localisation for a mod.

Protected Properties

Property	Type	Description
_currentLanguage	Language
_languages	List
_languagesLoaded	bool
_loadLanguageAutomatically	bool

Method	Description
AvailableLanguages ( ) : List	Returns a list of languages which are available to the mod. This will return language IDs for searching.
AvailableLanguagesReadable ( ) : List	Returns a list of languages which are available to the mod. This will return readable languages for use on the UI
GetLanguageIDsFromName ( string name ) : List	Returns a list of Language unique IDs that have the name
GetTranslation ( string translationId ) : string	Gets a translation for a specific translation ID
HasTranslation ( string translationId ) : bool	Returns whether you can translate into a specific translation ID
LoadLanguages ( ) : void	Loads all languages up if not already loaded.
RefreshLanguages ( ) : void	Forces a reload of the languages, even if they're already loaded
Translation ( bool loadLanguageAutomatically = true ) : System.Collections.Generic

Method	Description
DeserialiseLanguage ( TextReader reader ) : Language	Deserialise a language file using a TextReader

Method	Description
SetCurrentLanguage ( ) : void

Returns a list of languages which are available to the mod. This will return language IDs for searching.

public AvailableLanguages ( ) : List
return	List

Returns a list of languages which are available to the mod. This will return readable languages for use on the UI

public AvailableLanguagesReadable ( ) : List
return	List

Deserialise a language file using a TextReader

protected DeserialiseLanguage ( TextReader reader ) : Language
reader	System.IO.TextReader	The text to deserialise
return	Language

Returns a list of Language unique IDs that have the name

public GetLanguageIDsFromName ( string name ) : List
name	string	The name of the language to get IDs for
return	List

Gets a translation for a specific translation ID

public GetTranslation ( string translationId ) : string
translationId	string	The ID to return the translation for
return	string

Returns whether you can translate into a specific translation ID

public HasTranslation ( string translationId ) : bool
translationId	string	The ID of the translation to check
return	bool

Loads all languages up if not already loaded.

public LoadLanguages ( ) : void
return	void

Forces a reload of the languages, even if they're already loaded

public RefreshLanguages ( ) : void
return	void

public Translation ( bool loadLanguageAutomatically = true ) : System.Collections.Generic
loadLanguageAutomatically	bool
return	System.Collections.Generic

protected Language,NaturalResourcesBrush.TranslationFramework _currentLanguage
return	Language

protected List _languages
return	List

protected bool _languagesLoaded
return	bool

protected bool _loadLanguageAutomatically
return	bool