Locale

Description

Represents a selectable language or region in a localized project. A locale carries a culture code, an optional display name, a formatting culture, and an optional fallback.

A locale is the unit the runtime selects between when it resolves localized content. It pairs a LocaleIdentifier (the culture code) with a display name and the formatting culture reported by Locale.CultureInfo, which drives number, date, and string formatting. When a value is missing in the selected locale, the runtime can fall back to the locale named by Locale.FallbackCode. A locale is a plain serializable object rather than a ScriptableObject asset, so it is stored inline in the localization settings.

Additional resources: LocaleIdentifier, ResourceTable, SharedTableData

<para>Create a locale, then read its identifier, display name, and formatting culture.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class LocaleOverviewExample
    {
        public void Run()
        {
            var locale = new Locale("fr-CA", "French (Canada)");

            Debug.Log(locale.Identifier);        // fr-CA
            Debug.Log(locale.LocaleName);        // French (Canada)
            Debug.Log(locale.CultureInfo.Name);  // fr-CA
            Debug.Log(locale.Enabled);           // True
        }
    }
}

Properties

Constructors