Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

LoadAssetAsync<T>(AssetKey, CancellationToken)

Loads the asset identified by the key as the requested type.
Read time 1 minuteLast updated 13 days ago

Definition

Awaitable<T> LoadAssetAsync<T>(AssetKey key, CancellationToken cancellationToken) where T : Object

Parameters

key

AssetKey
The asset to load.

cancellationToken

CancellationToken
A token that cancels the load.

Returns

Type

Description

Awaitable<T>The loaded asset, or 
null
when it cannot be resolved.

Remarks

The asset type is 
T
, or AssetKey.Type when 
T
is the base Object, so a type-erased caller can pass 
<Object>
and carry the type on the key. Completes with 
null
when the key cannot be resolved, or when the resolved asset is not a 
T
. A cancelled load throws OperationCanceledException.
Load a texture through a provider.

Examples

using System.Threading;using Unity.Localization.Providers;using UnityEngine;namespace Unity.Localization.Samples{    public class IAsyncAssetProviderLoadAssetGenericExample    {        public async Awaitable Run()        {            IAsyncAssetProvider provider = new ResourceFolderProvider();            var texture = await provider.LoadAssetAsync<Texture2D>(                new AssetKey("UI/Logo", typeof(Texture2D)), CancellationToken.None);            if (texture != null)                Debug.Log(texture.name);        }    }}