Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


RefreshString()

Re-resolves the value and pushes the result to subscribers.
Read time 1 minuteLast updated 7 days ago

Definition

  • Type: Method
  • Namespace: Unity.Localization
  • Assembly: UnityEngine.LocalizationRuntimeModule
public void RefreshString()

Remarks

Resolves the string again and invokes LocalizedString.StringChanged with the new value. Does nothing when no handler is subscribed. It runs automatically when the reference changes or the selected locale changes, so call it manually only when an external input, such as a value in LocalizedString.LocalVariables, changes.
Refresh after changing a local variable that the string formats against.

Examples

using Unity.Localization;using Unity.SmartStrings.PersistentVariables;namespace Unity.Localization.Samples{ public class LocalizedStringRefreshExample { public void Refresh() { var localizedString = new LocalizedString(); localizedString.SetReference("My Strings", "SCORE"); localizedString.LocalVariables.Add(new IntVariable { Value = 10 }, "score"); localizedString.RefreshString(); } }}