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

LocalizedString.RefreshString

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

Declaration

public void RefreshString();

Description

Re-resolves the value and pushes the result to subscribers.

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.

<para>Refresh after changing a local variable that the string formats against.</para>

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(); } } }