Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetEntryAsync(CancellationToken)

Resolves the entry asynchronously, loading the table if it is not already available.
Read time 1 minuteLast updated 8 days ago

Definition

  • Type: Method
  • Namespace: Unity.Localization
  • Assembly: UnityEngine.LocalizationRuntimeModule
public Awaitable<TEntry> GetEntryAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken

CancellationToken
A token that cancels the asynchronous load. The default token never cancels.

Returns

Type

Description

Awaitable<T>An awaitable that produces the resolved entry, or null when it cannot be resolved.

Remarks

The entry is resolved as 
TEntry
through the ResourceDatabase provider chain, following the locale fallback chain when LocalizedReference.EnableFallback is set. The result is null when the reference is empty, no resource database is configured, or the entry cannot be found. The resolved entry is cached and reused until the reference changes or the resolving locale changes, so repeated calls do not resolve again. The LocalizedString and LocalizedAsset<TObject> types build on this cache to format or load the same entry without resolving it every time.
Load an entry asynchronously.

Examples

using Unity.Localization;using UnityEngine;namespace Unity.Localization.Samples{    public class LocalizedEntryGetEntryAsyncExample    {        public async Awaitable Load()        {            var reference = new LocalizedString();            reference.SetReference("My Strings", "HELLO");            var entry = await reference.GetEntryAsync();            if (entry != null)                Debug.Log(entry.Value);        }    }}