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

IAsyncAssetProvider.LoadAssetAsync

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<T> LoadAssetAsync(AssetKey key, CancellationToken cancellationToken);

Parameters

Parameter Description
key The asset to load.
cancellationToken A token that cancels the load.

Returns

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

Description

Loads the asset identified by the key as the requested type.

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.

<para>Load a texture through a provider.</para>

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