AsyncOperation
Class representing an asynchronous operation, which can be used as a yield instruction in a coroutine or awaited with the await operator.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: YieldInstruction
public class AsyncOperation : YieldInstruction
Remarks
AsyncOperationyield- Check its progress without any coroutine, for example checking AsyncOperation.isDone or AsyncOperation.progress inside MonoBehaviour.Update().
- Subscribe to its completed event AsyncOperation.completed to receive a callback when it finishes.
- Adjust properties such as AsyncOperation.allowSceneActivation while it's running.
- Await its completion with the key word as part of Unity's Awaitable support.
await
Examples
using System.Collections;using UnityEngine;public class ExampleClass : MonoBehaviour{ public void Start() { StartCoroutine(Example_AsyncTests()); } public IEnumerator Example_AsyncTests() { Debug.Log("Start of AsyncLoad Example"); var load = UnityEngine.Resources.LoadAsync(""); yield return load; yield return null; Debug.Log("End of AsyncLoad Example"); }}
Properties
Property | Description |
|---|---|
| allowSceneActivation | Allows a scene to be activated as soon as it's ready. |
| isDone | When the value is true, then the operation has finished. Otherwise, the operation is in progress. (Read Only) |
| priority | Integer representing the execution order priority of this AsyncOperation. |
| progress | A floating point value representing the operation's current state of progress toward completion, where 1.0 represents completion. (Read Only) |
Events
Member | Description |
|---|---|
| completed | Raised when this AsyncOperation operation has completed. |