VRage.Game.Localization.MyLocalizationContext Class Reference

Class designed around an idea of localization contexts. Context can be game, gui screen, mission, campaign or a task. Consists of a multitude of files stored in content folder. Each context can be modded, same way as created. More...

Classes
struct	LocalizationFileInfo

Public Member Functions
void	Dispose ()
	Clears all data before shutting down context. More...
void	Switch (string language)
	Tries to switch context to provided language. More...
StringBuilder	Localize (MyStringId id)
	Retrives the localized content from entry with provided id. More...
override int	GetHashCode ()
override bool	Equals (object obj)

Protected Member Functions
StringBuilder	AllocateOrGet (string text)
	Creates or provides already existing string builder. More...
bool	Equals (MyLocalizationContext other)

Protected Attributes
readonly MyStringId	m_contextName
readonly List< string >	m_languagesHelper = new List<string>()
readonly Dictionary< MyStringId, MyObjectBuilder_Localization >	m_loadedFiles = new Dictionary<MyStringId, MyObjectBuilder_Localization>(MyStringId.Comparer)
readonly Dictionary< MyStringId, StringBuilder >	m_idsToTexts = new Dictionary<MyStringId, StringBuilder>(MyStringId.Comparer)

Properties
ListReader< string >	Languages [get]
	Defined languages. More...
IEnumerable< MyStringId >	Ids [get]
	All accessible ids from context. More...
MyStringId	Name [get]
	Name of this context. More...
string	CurrentLanguage [get]
	Currently selected language. More...
StringBuilder	this[MyStringId id] [get]
	Simplified accessor. More...
StringBuilder	this[string nameId] [get]
	Simplified accessor. Preferably use the string id version. More...

Detailed Description

Class designed around an idea of localization contexts. Context can be game, gui screen, mission, campaign or a task. Consists of a multitude of files stored in content folder. Each context can be modded, same way as created.

Definition at line 18 of file MyLocalizationContext.cs.

Member Function Documentation

StringBuilder VRage.Game.Localization.MyLocalizationContext.AllocateOrGet ( string  text )

inlineprotected

Creates or provides already existing string builder.

Parameters

text

Returns

Definition at line 309 of file MyLocalizationContext.cs.

void VRage.Game.Localization.MyLocalizationContext.Dispose ( )

inline

Clears all data before shutting down context.

Definition at line 114 of file MyLocalizationContext.cs.

bool VRage.Game.Localization.MyLocalizationContext.Equals ( MyLocalizationContext  other )

inlineprotected

Definition at line 354 of file MyLocalizationContext.cs.

override bool VRage.Game.Localization.MyLocalizationContext.Equals ( object  obj )

inline

Definition at line 359 of file MyLocalizationContext.cs.

override int VRage.Game.Localization.MyLocalizationContext.GetHashCode ( )

inline

Definition at line 349 of file MyLocalizationContext.cs.

StringBuilder VRage.Game.Localization.MyLocalizationContext.Localize ( MyStringId  id )

inline

Retrives the localized content from entry with provided id.

Parameters

id	Unique identifier.

Returns

Localized builder.

Definition at line 329 of file MyLocalizationContext.cs.

void VRage.Game.Localization.MyLocalizationContext.Switch ( string  language )

inline

Tries to switch context to provided language.

Parameters

language

Definition at line 221 of file MyLocalizationContext.cs.

Member Data Documentation

readonly MyStringId VRage.Game.Localization.MyLocalizationContext.m_contextName

protected

Definition at line 39 of file MyLocalizationContext.cs.

readonly Dictionary<MyStringId, StringBuilder> VRage.Game.Localization.MyLocalizationContext.m_idsToTexts = new Dictionary<MyStringId, StringBuilder>(MyStringId.Comparer)

protected

Definition at line 47 of file MyLocalizationContext.cs.

readonly List<string> VRage.Game.Localization.MyLocalizationContext.m_languagesHelper = new List<string>()

protected

Definition at line 41 of file MyLocalizationContext.cs.

readonly Dictionary<MyStringId, MyObjectBuilder_Localization> VRage.Game.Localization.MyLocalizationContext.m_loadedFiles = new Dictionary<MyStringId, MyObjectBuilder_Localization>(MyStringId.Comparer)

protected

Definition at line 45 of file MyLocalizationContext.cs.

Property Documentation

string VRage.Game.Localization.MyLocalizationContext.CurrentLanguage

get

Currently selected language.

Definition at line 87 of file MyLocalizationContext.cs.

IEnumerable<MyStringId> VRage.Game.Localization.MyLocalizationContext.Ids

get

All accessible ids from context.

Definition at line 68 of file MyLocalizationContext.cs.

ListReader<string> VRage.Game.Localization.MyLocalizationContext.Languages

get

Defined languages.

Definition at line 57 of file MyLocalizationContext.cs.

MyStringId VRage.Game.Localization.MyLocalizationContext.Name

get

Name of this context.

Definition at line 79 of file MyLocalizationContext.cs.

StringBuilder VRage.Game.Localization.MyLocalizationContext.this[MyStringId id]

get

Simplified accessor.

Parameters

id	Tag to localize.

Returns

Localized String Builder.

Definition at line 195 of file MyLocalizationContext.cs.

StringBuilder VRage.Game.Localization.MyLocalizationContext.this[string nameId]

get

Simplified accessor. Preferably use the string id version.

Parameters

nameId

Name identifier. (will be converted to MyStringId)

Returns

Localized String Builder.

Definition at line 208 of file MyLocalizationContext.cs.

---

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

• Sources/VRage.Game/Localization/MyLocalizationContext.cs