class in Unity.Localization
/
Inherits from:Unity.Localization.LocalizedString
Implements interfaces:ILocalizedStringList
A localized string list stored as one table entry whose value is split on a separator.
The referenced entry holds every item in one value, for example Low,Medium,High, and the list splits it on
LocalizedStringList.Separator. One entry keeps the items together for translators, who can reorder them per language.
Splitting does not trim the value, so spaces around the separator stay part of the items.
Additional resources: ILocalizedStringList, LocalizedStringGroup
Resolve a list of options and fill a dropdown.
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); } } }
| Property | Description |
|---|---|
| Separator | The text that separates the items inside the entry's value. |
| Property | Description |
|---|---|
| isDirty | When set to true, the binding instance updates during the next update cycle. When set to false, the binding instance updates only if a change is detected. |
| updateTrigger | When set to BindingUpdateTrigger.EveryUpdate, the binding instance updates in every update, regardless of the data source version. |
| IsEmpty | Whether this reference is unset and resolves to no value. |
| TableEntryReference | The entry within the table collection that this reference resolves. |
| EnableFallback | Whether to walk the locale fallback chain when the resolving locale has no value for this reference. |
| HasLocaleOverride | Whether a locale override is set on this reference. |
| IsEmpty | Whether this reference is unset and resolves to no value. |
| LocaleOverride | The locale used to resolve this reference instead of the locale selected in the project settings. |
| TableReference | The localization table collection that this reference resolves against. |
| LocalVariables | The local variables that Smart String placeholders resolve against when this string is formatted. |
| Method | Description |
|---|---|
| MarkDirty | Notifies the binding system to process this binding. |
| OnActivated | Called when the binding becomes active for a specific VisualElement. |
| OnDataSourceChanged | Called when the resolved data source of a binding changes. |
| OnDeactivated | Called when the binding is no longer active for a specific VisualElement. |
| Update | Called when the binding system updates the binding. |
| GetEntry | Resolves the entry synchronously from already-loaded tables without triggering a load. |
| GetEntryAsync | Resolves the entry asynchronously, loading the table if it is not already available. |
| SetReference | Sets the table and entry references together so the reference refreshes only once. |
| OnActivated | Starts resolving the reference when it becomes active on an element. |
| OnDeactivated | Stops resolving the reference once it is no longer active on any element. |
| Update | Writes the resolved value to the bound field. |
| GetLocalizedString | Resolves the localized string synchronously when the table is cached or a synchronous provider can supply it. |
| GetLocalizedStringAsync | Resolves the localized string asynchronously, formatting it with the given arguments. |
| GetSourceValue | Resolves this string so it can be read as a Smart String placeholder in another string. |
| RefreshString | Re-resolves the value and pushes the result to subscribers. |
| Method | Description |
|---|---|
| ForceUpdate | Called when the reference changes so subclasses can refresh any live listeners. |
| ResolveOverrideLocale | Resolves the override locale from the project settings for subclasses to pass to the resource database. |
| Method | Description |
|---|---|
| GetGlobalLogLevel | Gets the global log level for all binding failures. |
| GetPanelLogLevel | Gets the log level for binding failures on a panel. |
| ResetPanelLogLevel | Resets the log level for binding failures on a panel to use the global setting. |
| SetGlobalLogLevel | Sets the log level for all binding failures. |
| SetPanelLogLevel | Sets the log level for binding failures on a panel. |
| Event | Description |
|---|---|
| StringChanged | Occurs when the resolved string value changes, and once immediately when a handler subscribes. |
| Delegate | Description |
|---|---|
| ChangeHandler | Represents a method that receives a resolved localized string value. |