Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetLocalizedString(params object[])

Resolves the localized string synchronously when the table is cached or a synchronous provider can supply it.
Read time 1 minuteLast updated 7 days ago

Definition

  • Type: Method
  • Namespace: Unity.Localization
  • Assembly: UnityEngine.LocalizationRuntimeModule

GetLocalizedString(Object[])

public string GetLocalizedString(params object[] args)

Parameters

args

Object[]
Optional arguments that Smart String placeholders format against.

Returns

Type

Description

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

Remarks

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.
Read an already-loaded localized string.

Examples

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