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

ResourceDatabase.GetLocalizedAssetAsync

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 Awaitable<TObject> GetLocalizedAssetAsync(TableReference tableRef, TableEntryReference entryRef, Locale locale, CancellationToken cancellationToken);

Parameters

Parameter Description
tableRef The reference to the table collection that holds the entry.
entryRef The reference to the asset entry to resolve within the table.
locale The locale to resolve in; null uses the selected locale.
cancellationToken The token that cancels the load operation.

Returns

Awaitable<TObject> The loaded localized asset, or null when the entry has no asset for the locale.

Description

Resolves a localized asset: the direct reference when present, otherwise through the provider chain.

The entry resolves in the requested locale, following the fallback chain when it has no asset. The loaded asset is cached per locale and variant, so a matching entry is loaded once and reused. Release cached assets with ResourceDatabase.ReleaseAssets or ResourceDatabase.ReleaseAllAssets when they are no longer needed.

<para>Loads a localized sprite for the selected locale.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples { public class GetLocalizedAssetAsyncExample : MonoBehaviour { async void Start() { Sprite flag = await LocalizationSettings.ResourceDatabase .GetLocalizedAssetAsync<Sprite>("UI Assets", "flag"); Debug.Log(flag != null ? flag.name : "no flag"); } } }