unity-unitask-design

Return UniTask, UniTask<T>, or UniTaskVoid from async methods instead of Task, and always await the result or call .Forget(). Accept a CancellationToken as the last parameter and forward it to primitives like UniTask.Delay so cancellation propagates correctly.

UniTask is a struct wrapping a pooled IUniTaskSource and token; after the first await the source is recycled, so a second await throws InvalidOperationException. Call .Preserve() once to get a memoized UniTask that can be awaited multiple times.

Call this.GetCancellationTokenOnDestroy() on a MonoBehaviour, GameObject, or Component to get a token that cancels on OnDestroy. Plain C# classes must own and dispose their own CancellationTokenSource instead.

No. UniTask.Run, RunOnThreadPool, and SwitchToThreadPool throw NotSupportedException on WebGL because the platform is single-threaded. Guard those calls with #if UNITY_WEBGL && !UNITY_EDITOR and run the work synchronously as a fallback.

UniTask.Yield may resume on the same frame if awaited from an earlier PlayerLoop phase than the target timing, while NextFrame guarantees the continuation runs on a subsequent frame. Use NextFrame to split work across frames and Yield(timing) to target a specific phase.

Call .ToUniTask() on the operation, optionally passing an IProgress<float> and CancellationToken. For UnityWebRequest, wrap the await in try/catch for UnityWebRequestException to inspect Result, ResponseCode, and Error on failure.