ILocalizedStringList
Interface for resolving a localized list of strings.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Interface
- Namespace: Unity.Localization
- Assembly: UnityEngine.LocalizationRuntimeModule
public interface ILocalizedStringList
Remarks
Implementations resolve one or more table entries into an ordered list, for example the options of a dropdown. Subscribe to ILocalizedStringList.ListChanged to receive the values and every later change, including locale switches, or resolve on demand with ILocalizedStringList.GetLocalizedList and ILocalizedStringList.GetLocalizedListAsync. The built-in implementations are LocalizedStringList, which splits one entry on a separator, and LocalizedStringGroup, which combines several entries.
Resolve a list of options and fill a dropdown.
Examples
using System.Collections.Generic;using Unity.Localization;using UnityEngine;namespace Unity.Localization.Samples{ public class LocalizedStringListExample { public async Awaitable Load() { // The entry's value holds every option, for example "Low,Medium,High". var options = new LocalizedStringList { Separator = "," }; options.SetReference("My Strings", "QUALITY OPTIONS"); List<string> values = await options.GetLocalizedListAsync(); Debug.Log(values.Count); } }}
Methods
Method | Description |
|---|---|
| GetLocalizedList | Resolves the localized values without waiting. |
| GetLocalizedListAsync | Resolves the localized values, loading tables as needed. |
Events
Member | Description |
|---|---|
| ListChanged | Raised with the localized values when the list first resolves and again whenever a value changes. |