Static Public Member Functions | Properties | List of all members
PixelCrushers.DialogueSystem.Localization Class Reference

This static class contains localization methods and the current language as defined by a string (e.g., "es" for generic Spanish, "fr-CA" for French - Canadian). More...

Static Public Member Functions

static string GetLanguage (SystemLanguage systemLanguage)
 Converts a Unity SystemLanguage enum value to a language string. More...
 

Properties

static string Language [get, set]
 Gets or sets the current language. More...
 
static bool IsDefaultLanguage [get]
 Indicates whether localization is set to use default text instead of localized text. More...
 
static bool UseDefaultIfUndefined [get, set]
 Gets or sets a value indicating whether to use the default language's field value if a field is undefined for the current language. More...
 

Detailed Description

This static class contains localization methods and the current language as defined by a string (e.g., "es" for generic Spanish, "fr-CA" for French - Canadian).

Member Function Documentation

◆ GetLanguage()

static string PixelCrushers.DialogueSystem.Localization.GetLanguage ( SystemLanguage  systemLanguage)
static

Converts a Unity SystemLanguage enum value to a language string.

Returns
The language string representation of the specified systemLanguage.
Parameters
systemLanguageA Unity SystemLanguage enum value.

Property Documentation

◆ IsDefaultLanguage

bool PixelCrushers.DialogueSystem.Localization.IsDefaultLanguage
staticget

Indicates whether localization is set to use default text instead of localized text.

true if default text should be used. If false, the language specified by the Language property should be used.

◆ Language

string PixelCrushers.DialogueSystem.Localization.Language
staticgetset

Gets or sets the current language.

The language.

◆ UseDefaultIfUndefined

bool PixelCrushers.DialogueSystem.Localization.UseDefaultIfUndefined
staticgetset

Gets or sets a value indicating whether to use the default language's field value if a field is undefined for the current language.

true if use default if undefined; otherwise, false.

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