Interface ILocalesProvider
Holds the Locale's that the project supports.
Namespace: UnityEngine.Localization.Settings
Syntax
public interface ILocalesProviderProperties
Locales
The list of Locales available.
Declaration
List<Locale> Locales { get; }Property Value
| Type | Description |
|---|---|
| List<Locale> |
Methods
AddLocale(Locale)
Add a Locale to allow support for a specific language.
Declaration
void AddLocale(Locale locale)Parameters
| Type | Name | Description |
|---|---|---|
| Locale | locale | The locale to add. |
GetLocale(LocaleIdentifier)
Attempt to retrieve a Locale using the identifier.
Declaration
Locale GetLocale(LocaleIdentifier id)Parameters
| Type | Name | Description |
|---|---|---|
| LocaleIdentifier | id | LocaleIdentifier to find. |
Returns
| Type | Description |
|---|---|
| Locale | If no Locale can be found then null is returned. |
RemoveLocale(Locale)
Removes support for a specific Locale.
Declaration
bool RemoveLocale(Locale locale)Parameters
| Type | Name | Description |
|---|---|---|
| Locale | locale | The locale that should be removed if possible. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the locale was removed or false if the locale did not exist. |