Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

IStartupLocaleInitialize

Optional hook a startup selector implements to run code once after initialization completes.
Read time 1 minuteLast updated 10 days ago

Definition

  • Type: Interface
  • Namespace: Unity.Localization
  • Assembly: UnityEngine.LocalizationRuntimeModule
public interface IStartupLocaleInitialize

Remarks

Implement this interface alongside IStartupLocaleSelector when a selector needs one-time setup after the startup locale is chosen, for example subscribing to LocalizationSettings.SelectedLocaleChanged to persist later locale changes. LocalizationSettings.InitializeAsync calls IStartupLocaleInitialize.PostInitialize on each selector that implements this interface once initialization has finished. PlayerPrefLocaleSelector uses this hook to save the selected locale.
Additional Resources: IStartupLocaleSelector, LocalizationSettings
A selector that logs the chosen locale after startup.

Examples

using Unity.Localization;using UnityEngine;namespace Unity.Localization.Samples{    public class LoggingLocaleSelectorExample : IStartupLocaleSelector, IStartupLocaleInitialize    {        public Locale GetStartupLocale(LocalizationSettings settings) => null;        public void PostInitialize(LocalizationSettings settings)        {            Debug.Log($"Startup locale: {LocalizationSettings.SelectedLocale?.Code}");        }    }}

Methods

Method

Description

PostInitializeRuns one-time setup once the startup locale has been selected.