VRage.Game.Localization.MyLocalization Class Reference

Classes
struct	MyBundle

Public Member Functions
void	Switch (string language)
	Switches all contexts to provided language. More...
bool	DisposeContext (MyStringId nameId)
	Tries to dispose disposable context. More...
void	DisposeAll ()
	Tries to dispose all disposable contexts. More...
void	LoadBundle (MyBundle bundle, List< MyLocalizationContext > influencedContexts=null)
	Loads bundle of files under bundle id. More...
void	UnloadBundle (MyStringId bundleId)
	Unloads bundle of files from the system by given id. More...
StringBuilder	Get (MyStringId contextId, MyStringId id)
	Returns localization for given context and id. More...

Static Public Member Functions
static void	Initialize ()
	Initializes singleton. More...

Static Public Attributes
static readonly string	LOCALIZATION_FOLDER = "Data\\Localization"

Properties
static MyLocalization	Static [get]
StringBuilder	this[MyStringId contextName, MyStringId tag] [get]
	Simplified accessor. More...
StringBuilder	this[string contexName, string tag] [get]
	Simplified accessor. Preferably use the string id version. More...
MyLocalizationContext	this[MyStringId contextName] [get]
	Simplified accessor. More...
MyLocalizationContext	this[string contextName] [get]
	Simplified accessor. Preferably use the string id version. More...

Detailed Description

Definition at line 13 of file MyLocalization.cs.

Member Function Documentation

void VRage.Game.Localization.MyLocalization.DisposeAll ( )

inline

Tries to dispose all disposable contexts.

Definition at line 237 of file MyLocalization.cs.

bool VRage.Game.Localization.MyLocalization.DisposeContext ( MyStringId  nameId )

inline

Tries to dispose disposable context.

Parameters

nameId

Name id of context.

Definition at line 221 of file MyLocalization.cs.

StringBuilder VRage.Game.Localization.MyLocalization.Get ( MyStringId  contextId, MyStringId  id  )

inline

Returns localization for given context and id.

Parameters

contextId	Context name id.
id	Message identifier.

Returns

String builder with localization.

Definition at line 343 of file MyLocalization.cs.

static void VRage.Game.Localization.MyLocalization.Initialize ( )

inlinestatic

Initializes singleton.

Definition at line 45 of file MyLocalization.cs.

void VRage.Game.Localization.MyLocalization.LoadBundle ( MyBundle  bundle, List< MyLocalizationContext >  influencedContexts = null  )

inline

Loads bundle of files under bundle id.

Parameters

bundle	Data bundle.
influencedContexts	Contexts that got some new data in the process.

Definition at line 248 of file MyLocalization.cs.

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

inline

Switches all contexts to provided language.

Parameters

language

Language name.

Definition at line 204 of file MyLocalization.cs.

void VRage.Game.Localization.MyLocalization.UnloadBundle ( MyStringId  bundleId )

inline

Unloads bundle of files from the system by given id.

Parameters

bundleId

Definition at line 271 of file MyLocalization.cs.

Member Data Documentation

readonly string VRage.Game.Localization.MyLocalization.LOCALIZATION_FOLDER = "Data\\Localization"

static

Definition at line 22 of file MyLocalization.cs.

Property Documentation

MyLocalization VRage.Game.Localization.MyLocalization.Static

staticget

Definition at line 29 of file MyLocalization.cs.

StringBuilder VRage.Game.Localization.MyLocalization.this[MyStringId contextName, MyStringId tag]

get

Simplified accessor.

Parameters

contextName	Name id of context.
tag	Tag to translate.

Returns

Localized String builder.

Definition at line 286 of file MyLocalization.cs.

MyLocalizationContext VRage.Game.Localization.MyLocalization.this[MyStringId contextName]

get

Simplified accessor.

Parameters

contextName

Name id of context.

Returns

Context of given name.

Definition at line 313 of file MyLocalization.cs.

StringBuilder VRage.Game.Localization.MyLocalization.this[string contexName, string tag]

get

Simplified accessor. Preferably use the string id version.

Parameters

contexName	Name of the context.
tag	Name of the tag.

Returns

Definition at line 300 of file MyLocalization.cs.

MyLocalizationContext VRage.Game.Localization.MyLocalization.this[string contextName]

get

Simplified accessor. Preferably use the string id version.

Parameters

contextName

Name id of context.

Returns

Context of given name.

Definition at line 328 of file MyLocalization.cs.

---

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

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