Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

LocalizedString.StringChanged

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Occurs when the resolved string value changes, and once immediately when a handler subscribes.

Adding a handler invokes it right away with the current value, then again whenever the selected locale changes or LocalizedString.RefreshString runs. Because resolution is asynchronous, the first call arrives after the value has loaded. Removing the last handler stops the reference from listening for locale changes.

Additional resources: LocalizedString.RefreshString, LocalizedString.GetLocalizedStringAsync

<para>Update a UI label whenever the localized value changes.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples { public class LocalizedStringChangedExample : MonoBehaviour { public TextMesh label;

void Start() { var localizedString = new LocalizedString(); localizedString.SetReference("My Strings", "HELLO"); // Raised whenever the value changes, including when the selected locale changes. localizedString.StringChanged += value => label.text = value; } } }