LocalizedString.GetLocalizedString

Parameters

Returns

string The formatted localized string, or an empty string when it is not available synchronously.

Description

Resolves the localized string synchronously when the table is cached or a synchronous provider can supply it.

Formats Smart String placeholders against the supplied arguments and LocalizedString.LocalVariables. The table resolves from the cache, or through a provider that supports synchronous loading; the result is an empty string when the reference is empty or the table can only be loaded asynchronously. Use LocalizedString.GetLocalizedStringAsync to load the table asynchronously instead.

<para>Read an already-loaded localized string.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class LocalizedStringSyncExample
    {
        public void Read()
        {
            var localizedString = new LocalizedString();
            localizedString.SetReference("My Strings", "HELLO");
            string text = localizedString.GetLocalizedString();
            Debug.Log(text);
        }
    }
}