Unity - Scripting API: Awaitable
class in UnityEngine
/
Implemented in:UnityEngine.CoreModule
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.
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.
Description
Awaitable type used to expose asynchronous code, as well as an async return type specifically tailored for Unity.
Properties
| IsCompleted | Indicates if the awaitable has run to completion. |
Public Methods
| Cancel | Cancel the awaitable. If the awaitable is being awaited, the awaiter will get a System.OperationCanceledException. |
Static Methods
| 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. |