Is it possible in Unity to do something like this?
private async void LoadSomethingAsync()
{
AudioClip clip = await Resources.LoadAsync<AudioClip>("path");
}
I know I could use Unitys Coroutines instead, but they have multiple downsides why I would like to use something like the code above.
On the internet I didn't found something that works for me either, so maybe someone of you knows if something like the code above is possible or not.
You can try this.This library makes all Unity AsyncOperations and Coroutines awaitable: https://github.com/Cysharp/UniTask
Also, it is not recommended to combine async with void as in the code in question.
I've never used Addressables, but here is some relevant documentation:
Addressables also supports asynchronous await through the AsyncOperationHandle.Task property:
public async Start() { AsyncOperationHandle<Texture2D> handle = Addressables.LoadAssetAsync<Texture2D>("mytexture"); await handle.Task; // The task is complete. Be sure to check the Status is successful before storing the Result. }
So to me it seems like you could switch to using Addressables, then do this:
private async void LoadSomethingAsync()
{
AsyncOperationHandle<AudioClip> handle = Addressables.LoadAssetAsync<AudioClip>("path");
await handle.Task;
if (handle.Status == AsyncOperationStatus.Succeeded)
{
AudioClip clip = handle.Result;
// use clip here
}
else
{
// handle loading error
}
}
Note that according to the documentation, this particular solution is not available on WebGL. This may not matter to you:
The
AsyncOperationHandle.Taskproperty is not available on WebGL as multi-threaded operations are not supported on that platform.
LoadSomethingAsync was started from the main threadYou can use Resources.LoadAsync(path) method for asynchronously loads an asset stored at path in a Resources folder.
The following code is an example to load an audio clip from the resource folder asynchronously,
private IEnumerator LoadAudioAsync(string path) {
ResourceRequest resourceRequest = Resources.LoadAsync<AudioClip>(path);
yield return resourceRequest;
AudioClip audioClip = resourceRequest.asset as AudioClip;
}
Use can also use Addressables to load the resources. But it supports only Unity 2019.3+ versions.
public async void LoadAudioAsync(string path) {
AsyncOperationHandle<AudioClip> resourceRequest = Addressables.LoadAssetAsync<AudioClip>(path);
await resourceRequest.Task;
}
For more examples: https://csharp.hotexamples.com/examples/UnityEngine/ResourceRequest/-/php-resourcerequest-class-examples.html
Starting Unity 2023.1, all types inheriting from AsyncOperation, including ResourceRequest returned by Resources.LoadAsync, support the async/await pattern.
Task obtained by awaiting an AsyncOperation have no TResult type associated (unlike AsyncOperationHandle<TObject>.task mentioned in other answers), so we need to store the ResourceRequest and retrieve the asset later (similarly to Ruzihm's answer with handle.Result, except ResourceRequest.asset is a mere Object so we'll have to cast it). There is no status to check though, so you'll have to check for null asset.
This gives:
private static async Task<AudioClip> LoadAudioClipAsync()
{
ResourceRequest clipRequest = Resources.LoadAsync<AudioClip>("path");
await clipRequest;
var clip = (AudioClip) clipRequest.asset;
return clip;
}
/* caller code */
AudioClip clip = await LoadAudioClipAsync();
// do something with clip
Source: https://docs.unity3d.com/2023.2/Documentation/Manual/AwaitSupport.html
AsyncOperationmethod,LoadSceneAsync. It uses the code in this github. It should "just work" withLoadAsync<T>.if something like the code above is possible or not.. even if, you anyway will have to make surethe result is used in the main thread in the end since most of Unity API can not be used on other threadsbut they have multiple downsides.. like what for example? ;)