Class Localization

The language and culture localization manager.

Localization
Assembly: FlaxEngine.dll
File: Engine/Localization/Localization.h
Syntax
public class Localization

Fields

LocalizationChanged

Occurs when current culture or language gets changed. Can be used to refresh UI to reflect language changes.

Declaration
public static Delegate LocalizationChanged
Field Value
Delegate

Methods

GetCurrentCulture()

Gets the current culture (date, time, currency and values formatting locale).

Declaration
public static CultureInfo GetCurrentCulture()
Returns
CultureInfo

GetCurrentLanguage()

Gets the current language (text display locale).

Declaration
public static CultureInfo GetCurrentLanguage()
Returns
CultureInfo

GetPluralString(const String& id, int32 n, const String& fallback=String::Empty)

Gets the localized plural string for the current language by using string id lookup.

Declaration
public static String GetPluralString(const String& id, int32 n, const String& fallback=String::Empty)
Parameters
String id

The message identifier.
int32 n

The value count for plural message selection.
String fallback

The optional fallback string value to use if localized string is missing.
Returns
String

The localized text.

GetString(const String& id, const String& fallback=String::Empty)

Gets the localized string for the current language by using string id lookup.

Declaration
public static String GetString(const String& id, const String& fallback=String::Empty)
Parameters
String id

The message identifier.
String fallback

The optional fallback string value to use if localized string is missing.
Returns
String

The localized text.

SetCurrentCulture(const CultureInfo& value)

Sets the current culture (date, time, currency and values formatting locale).

Declaration
public static void SetCurrentCulture(const CultureInfo& value)
Parameters
CultureInfo value

SetCurrentLanguage(const CultureInfo& value)

Sets the current language (text display locale).

Declaration
public static void SetCurrentLanguage(const CultureInfo& value)
Parameters
CultureInfo value

SetCurrentLanguageCulture(const CultureInfo& value)

Sets both the current language (text display locale) and the current culture (date, time, currency and values formatting locale) at once.

Declaration
public static void SetCurrentLanguageCulture(const CultureInfo& value)
Parameters
CultureInfo value