IStartupLocaleSelector

Description

Selects the locale to activate when the localization system initializes at startup.

Implement this interface to control which Locale becomes the selected locale on startup. During LocalizationSettings.InitializeAsync the configured selectors are evaluated in order and the first non-null result is used; if every selector returns null the system falls back to LocalizationSettings.ProjectLocale. Register selectors through LocalizationSettings.StartupSelectors. Built-in implementations include CommandLineLocaleSelector, SystemLocaleSelector, and PlayerPrefLocaleSelector.

Additional resources: LocalizationSettings, Locale

<para>A selector that picks a locale from a value read at startup.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class SaveFileLocaleSelectorExample : IStartupLocaleSelector
    {
        public Locale GetStartupLocale(LocalizationSettings settings)
        {
            string code = PlayerPrefs.GetString("preferred-language"); // for example "fr"
            return string.IsNullOrEmpty(code)
                ? null
                : settings?.GetLocale(new LocaleIdentifier(code));
        }
    }
}

Public Methods