Awaitable type used to expose asynchronous code, as well as an async return type specifically tailored for Unity.
private async Awaitable DoSomethingAsync() { await LoadSceneAsync("SomeScene"); await SomeApiReturningATask(); await Awaitable.NextFrameAsync(); // <...> }
IsCompleted | Indicates if the awaitable has run to completion. |
Cancel | Cancel the awaitable. If the awaitable is being awaited, the awaiter will get a System.OperationCanceledException. |
BackgroundThreadAsync | Resumes execution on a ThreadPool background thread. If the caller is already on a background thread, it will complete immediately. |
EndOfFrameAsync | Awaitable resuming after all Unity subsystem have run for the current frame. |
FixedUpdateAsync | Awaitable resuming on the next fixed update frame (see Time.fixedDeltaTime). |
FromAsyncOperation | Creates an Awaitable from an existing AsyncOperation object. |
MainThreadAsync | Resumes execution on the Unity main thread. If the caller is already on the main thread, it will complete immediately. |
NextFrameAsync | Awaitable resuming on next frame. |
WaitForSecondsAsync | Awaitable resuming after the specified number of seconds. |