UniTask Struct
Namespace: Cysharp.Threading.Tasks
Assembly: UniTask.dll
public readonly struct UniTask
  Members
Constructors
| Name | Description | 
|---|---|
| UniTask(IUniTaskSource, short) | 
Fields
| Name | Description | 
|---|---|
| CompletedTask | 
Properties
| Name | Description | 
|---|---|
| Status | 
Methods
Operators
| Name | Description | 
|---|---|
| implicit operator ValueTask(in UniTask) | 
Constructors
UniTask(IUniTaskSource, short)
public UniTask(IUniTaskSource source, short token)
  Parameters
sourceIUniTaskSourcetokenshort
Fields
CompletedTask
public static readonly UniTask CompletedTask
  Field Value
Properties
Status
public UniTaskStatus Status { get; }
  Property Value
Methods
Action(Func<UniTaskVoid>)
public static Action Action(Func<UniTaskVoid> asyncAction)
  Parameters
asyncActionFunc<UniTaskVoid>
Returns
Action(Func<CancellationToken, UniTaskVoid>, CancellationToken)
public static Action Action(Func<CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
  Parameters
asyncActionFunc<CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Returns
Action<T>(T, Func<T, UniTaskVoid>)
public static Action Action<T>(T state, Func<T, UniTaskVoid> asyncAction)
  Parameters
stateTasyncActionFunc<T, UniTaskVoid>
Returns
Type Parameters
T
AsAsyncUnitUniTask()
public UniTask<AsyncUnit> AsAsyncUnitUniTask()
  Returns
Create(Func<UniTask>)
public static UniTask Create(Func<UniTask> factory)
  Parameters
Returns
Create(Func<CancellationToken, UniTask>, CancellationToken)
public static UniTask Create(Func<CancellationToken, UniTask> factory, CancellationToken cancellationToken)
  Parameters
factoryFunc<CancellationToken, UniTask>cancellationTokenCancellationToken
Returns
Create<T>(Func<UniTask<T>>)
public static UniTask<T> Create<T>(Func<UniTask<T>> factory)
  Parameters
Returns
- UniTask<T>
 
Type Parameters
T
Create<T>(T, Func<T, UniTask>)
public static UniTask Create<T>(T state, Func<T, UniTask> factory)
  Parameters
Returns
Type Parameters
T
Defer(Func<UniTask>)
public static UniTask Defer(Func<UniTask> factory)
  Parameters
Returns
Defer<T>(Func<UniTask<T>>)
public static UniTask<T> Defer<T>(Func<UniTask<T>> factory)
  Parameters
Returns
- UniTask<T>
 
Type Parameters
T
Defer<TState>(TState, Func<TState, UniTask>)
public static UniTask Defer<TState>(TState state, Func<TState, UniTask> factory)
  Parameters
Returns
Type Parameters
TState
Defer<TState, TResult>(TState, Func<TState, UniTask<TResult>>)
public static UniTask<TResult> Defer<TState, TResult>(TState state, Func<TState, UniTask<TResult>> factory)
  Parameters
Returns
- UniTask<TResult>
 
Type Parameters
TStateTResult
Delay(int, DelayType, PlayerLoopTiming, CancellationToken, bool)
public static UniTask Delay(int millisecondsDelay, DelayType delayType, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
millisecondsDelayintdelayTypeDelayTypedelayTimingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
Delay(int, bool, PlayerLoopTiming, CancellationToken, bool)
public static UniTask Delay(int millisecondsDelay, bool ignoreTimeScale = false, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
millisecondsDelayintignoreTimeScalebooldelayTimingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
Delay(TimeSpan, DelayType, PlayerLoopTiming, CancellationToken, bool)
public static UniTask Delay(TimeSpan delayTimeSpan, DelayType delayType, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
delayTimeSpanTimeSpandelayTypeDelayTypedelayTimingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
Delay(TimeSpan, bool, PlayerLoopTiming, CancellationToken, bool)
public static UniTask Delay(TimeSpan delayTimeSpan, bool ignoreTimeScale = false, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
delayTimeSpanTimeSpanignoreTimeScalebooldelayTimingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
DelayFrame(int, PlayerLoopTiming, CancellationToken, bool)
public static UniTask DelayFrame(int delayFrameCount, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
delayFrameCountintdelayTimingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
FromCanceled(CancellationToken)
public static UniTask FromCanceled(CancellationToken cancellationToken = default)
  Parameters
cancellationTokenCancellationToken
Returns
FromCanceled<T>(CancellationToken)
public static UniTask<T> FromCanceled<T>(CancellationToken cancellationToken = default)
  Parameters
cancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
FromException(Exception)
public static UniTask FromException(Exception ex)
  Parameters
exException
Returns
FromException<T>(Exception)
public static UniTask<T> FromException<T>(Exception ex)
  Parameters
exException
Returns
- UniTask<T>
 
Type Parameters
T
FromResult<T>(T)
public static UniTask<T> FromResult<T>(T value)
  Parameters
valueT
Returns
- UniTask<T>
 
Type Parameters
T
GetAwaiter()
public UniTask.Awaiter GetAwaiter()
  Returns
Lazy(Func<UniTask>)
public static AsyncLazy Lazy(Func<UniTask> factory)
  Parameters
Returns
Lazy<T>(Func<UniTask<T>>)
public static AsyncLazy<T> Lazy<T>(Func<UniTask<T>> factory)
  Parameters
Returns
- AsyncLazy<T>
 
Type Parameters
T
Never(CancellationToken)
public static UniTask Never(CancellationToken cancellationToken)
  Parameters
cancellationTokenCancellationToken
Returns
Never<T>(CancellationToken)
public static UniTask<T> Never<T>(CancellationToken cancellationToken)
  Parameters
cancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
NextFrame()
public static UniTask NextFrame()
  Returns
NextFrame(PlayerLoopTiming)
public static UniTask NextFrame(PlayerLoopTiming timing)
  Parameters
timingPlayerLoopTiming
Returns
NextFrame(PlayerLoopTiming, CancellationToken, bool)
public static UniTask NextFrame(PlayerLoopTiming timing, CancellationToken cancellationToken, bool cancelImmediately = false)
  Parameters
timingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
NextFrame(CancellationToken, bool)
public static UniTask NextFrame(CancellationToken cancellationToken, bool cancelImmediately = false)
  Parameters
cancellationTokenCancellationTokencancelImmediatelybool
Returns
Post(Action, PlayerLoopTiming)
public static void Post(Action action, PlayerLoopTiming timing = PlayerLoopTiming.Update)
  Parameters
actionActiontimingPlayerLoopTiming
Preserve()
public UniTask Preserve()
  Returns
ReturnToCurrentSynchronizationContext(bool, CancellationToken)
public static ReturnToSynchronizationContext ReturnToCurrentSynchronizationContext(bool dontPostWhenSameContext = true, CancellationToken cancellationToken = default)
  Parameters
dontPostWhenSameContextboolcancellationTokenCancellationToken
Returns
ReturnToMainThread(PlayerLoopTiming, CancellationToken)
public static ReturnToMainThread ReturnToMainThread(PlayerLoopTiming timing, CancellationToken cancellationToken = default)
  Parameters
timingPlayerLoopTimingcancellationTokenCancellationToken
Returns
ReturnToMainThread(CancellationToken)
public static ReturnToMainThread ReturnToMainThread(CancellationToken cancellationToken = default)
  Parameters
cancellationTokenCancellationToken
Returns
ReturnToSynchronizationContext(SynchronizationContext, CancellationToken)
public static ReturnToSynchronizationContext ReturnToSynchronizationContext(SynchronizationContext synchronizationContext, CancellationToken cancellationToken = default)
  Parameters
synchronizationContextSynchronizationContextcancellationTokenCancellationToken
Returns
Run(Action, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask Run(Action action, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
actionActionconfigureAwaitboolcancellationTokenCancellationToken
Returns
Run(Action<object>, object, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask Run(Action<object> action, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
actionAction<object>stateobjectconfigureAwaitboolcancellationTokenCancellationToken
Returns
Run(Func<UniTask>, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask Run(Func<UniTask> action, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
actionFunc<UniTask>configureAwaitboolcancellationTokenCancellationToken
Returns
Run(Func<object, UniTask>, object, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask Run(Func<object, UniTask> action, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
Returns
RunOnThreadPool(Action, bool, CancellationToken)
public static UniTask RunOnThreadPool(Action action, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
actionActionconfigureAwaitboolcancellationTokenCancellationToken
Returns
RunOnThreadPool(Action<object>, object, bool, CancellationToken)
public static UniTask RunOnThreadPool(Action<object> action, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
actionAction<object>stateobjectconfigureAwaitboolcancellationTokenCancellationToken
Returns
RunOnThreadPool(Func<UniTask>, bool, CancellationToken)
public static UniTask RunOnThreadPool(Func<UniTask> action, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
actionFunc<UniTask>configureAwaitboolcancellationTokenCancellationToken
Returns
RunOnThreadPool(Func<object, UniTask>, object, bool, CancellationToken)
public static UniTask RunOnThreadPool(Func<object, UniTask> action, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
Returns
RunOnThreadPool<T>(Func<UniTask<T>>, bool, CancellationToken)
public static UniTask<T> RunOnThreadPool<T>(Func<UniTask<T>> func, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
funcFunc<UniTask<T>>configureAwaitboolcancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
RunOnThreadPool<T>(Func<object, UniTask<T>>, object, bool, CancellationToken)
public static UniTask<T> RunOnThreadPool<T>(Func<object, UniTask<T>> func, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
Returns
- UniTask<T>
 
Type Parameters
T
RunOnThreadPool<T>(Func<object, T>, object, bool, CancellationToken)
public static UniTask<T> RunOnThreadPool<T>(Func<object, T> func, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
funcFunc<object, T>stateobjectconfigureAwaitboolcancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
RunOnThreadPool<T>(Func<T>, bool, CancellationToken)
public static UniTask<T> RunOnThreadPool<T>(Func<T> func, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
funcFunc<T>configureAwaitboolcancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
Run<T>(Func<UniTask<T>>, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask<T> Run<T>(Func<UniTask<T>> func, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
funcFunc<UniTask<T>>configureAwaitboolcancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
Run<T>(Func<object, UniTask<T>>, object, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask<T> Run<T>(Func<object, UniTask<T>> func, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
Returns
- UniTask<T>
 
Type Parameters
T
Run<T>(Func<object, T>, object, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask<T> Run<T>(Func<object, T> func, object state, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
funcFunc<object, T>stateobjectconfigureAwaitboolcancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
Run<T>(Func<T>, bool, CancellationToken)
[Obsolete("UniTask.Run is similar as Task.Run, it uses ThreadPool. For equivalent behaviour, use UniTask.RunOnThreadPool instead. If you don't want to use ThreadPool, you can use UniTask.Void(async void) or UniTask.Create(async UniTask) too.")]
public static UniTask<T> Run<T>(Func<T> func, bool configureAwait = true, CancellationToken cancellationToken = default)
  Parameters
funcFunc<T>configureAwaitboolcancellationTokenCancellationToken
Returns
- UniTask<T>
 
Type Parameters
T
SuppressCancellationThrow()
public UniTask<bool> SuppressCancellationThrow()
  Returns
SwitchToMainThread(PlayerLoopTiming, CancellationToken)
public static SwitchToMainThreadAwaitable SwitchToMainThread(PlayerLoopTiming timing, CancellationToken cancellationToken = default)
  Parameters
timingPlayerLoopTimingcancellationTokenCancellationToken
Returns
SwitchToMainThread(CancellationToken)
public static SwitchToMainThreadAwaitable SwitchToMainThread(CancellationToken cancellationToken = default)
  Parameters
cancellationTokenCancellationToken
Returns
SwitchToSynchronizationContext(SynchronizationContext, CancellationToken)
public static SwitchToSynchronizationContextAwaitable SwitchToSynchronizationContext(SynchronizationContext synchronizationContext, CancellationToken cancellationToken = default)
  Parameters
synchronizationContextSynchronizationContextcancellationTokenCancellationToken
Returns
SwitchToTaskPool()
public static SwitchToTaskPoolAwaitable SwitchToTaskPool()
  Returns
SwitchToThreadPool()
public static SwitchToThreadPoolAwaitable SwitchToThreadPool()
  Returns
ToCoroutine(Func<UniTask>)
public static IEnumerator ToCoroutine(Func<UniTask> taskFactory)
  Parameters
Returns
ToString()
public override string ToString()
  Returns
Overrides
UnityAction(Func<UniTaskVoid>)
public static UnityAction UnityAction(Func<UniTaskVoid> asyncAction)
  Parameters
asyncActionFunc<UniTaskVoid>
Returns
- UnityAction
 
UnityAction(Func<CancellationToken, UniTaskVoid>, CancellationToken)
public static UnityAction UnityAction(Func<CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
  Parameters
asyncActionFunc<CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Returns
- UnityAction
 
UnityAction<T>(Func<T, UniTaskVoid>)
public static UnityAction<T> UnityAction<T>(Func<T, UniTaskVoid> asyncAction)
  Parameters
asyncActionFunc<T, UniTaskVoid>
Returns
- UnityAction<T>
 
Type Parameters
T
UnityAction<T>(Func<T, CancellationToken, UniTaskVoid>, CancellationToken)
public static UnityAction<T> UnityAction<T>(Func<T, CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
  Parameters
asyncActionFunc<T, CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Returns
- UnityAction<T>
 
Type Parameters
T
UnityAction<T>(T, Func<T, UniTaskVoid>)
public static UnityAction UnityAction<T>(T state, Func<T, UniTaskVoid> asyncAction)
  Parameters
stateTasyncActionFunc<T, UniTaskVoid>
Returns
- UnityAction
 
Type Parameters
T
UnityAction<T0, T1>(Func<T0, T1, UniTaskVoid>)
public static UnityAction<T0, T1> UnityAction<T0, T1>(Func<T0, T1, UniTaskVoid> asyncAction)
  Parameters
asyncActionFunc<T0, T1, UniTaskVoid>
Returns
- UnityAction<T0, T1>
 
Type Parameters
T0T1
UnityAction<T0, T1>(Func<T0, T1, CancellationToken, UniTaskVoid>, CancellationToken)
public static UnityAction<T0, T1> UnityAction<T0, T1>(Func<T0, T1, CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
  Parameters
asyncActionFunc<T0, T1, CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Returns
- UnityAction<T0, T1>
 
Type Parameters
T0T1
UnityAction<T0, T1, T2>(Func<T0, T1, T2, UniTaskVoid>)
public static UnityAction<T0, T1, T2> UnityAction<T0, T1, T2>(Func<T0, T1, T2, UniTaskVoid> asyncAction)
  Parameters
asyncActionFunc<T0, T1, T2, UniTaskVoid>
Returns
- UnityAction<T0, T1, T2>
 
Type Parameters
T0T1T2
UnityAction<T0, T1, T2>(Func<T0, T1, T2, CancellationToken, UniTaskVoid>, CancellationToken)
public static UnityAction<T0, T1, T2> UnityAction<T0, T1, T2>(Func<T0, T1, T2, CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
  Parameters
asyncActionFunc<T0, T1, T2, CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Returns
- UnityAction<T0, T1, T2>
 
Type Parameters
T0T1T2
UnityAction<T0, T1, T2, T3>(Func<T0, T1, T2, T3, UniTaskVoid>)
public static UnityAction<T0, T1, T2, T3> UnityAction<T0, T1, T2, T3>(Func<T0, T1, T2, T3, UniTaskVoid> asyncAction)
  Parameters
asyncActionFunc<T0, T1, T2, T3, UniTaskVoid>
Returns
- UnityAction<T0, T1, T2, T3>
 
Type Parameters
T0T1T2T3
UnityAction<T0, T1, T2, T3>(Func<T0, T1, T2, T3, CancellationToken, UniTaskVoid>, CancellationToken)
public static UnityAction<T0, T1, T2, T3> UnityAction<T0, T1, T2, T3>(Func<T0, T1, T2, T3, CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
  Parameters
asyncActionFunc<T0, T1, T2, T3, CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Returns
- UnityAction<T0, T1, T2, T3>
 
Type Parameters
T0T1T2T3
Void(Func<UniTaskVoid>)
public static void Void(Func<UniTaskVoid> asyncAction)
  Parameters
asyncActionFunc<UniTaskVoid>
Void(Func<CancellationToken, UniTaskVoid>, CancellationToken)
public static void Void(Func<CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
  Parameters
asyncActionFunc<CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Void<T>(Func<T, UniTaskVoid>, T)
public static void Void<T>(Func<T, UniTaskVoid> asyncAction, T state)
  Parameters
asyncActionFunc<T, UniTaskVoid>stateT
Type Parameters
T
WaitForEndOfFrame()
[Obsolete("Use WaitForEndOfFrame(MonoBehaviour) instead or UniTask.Yield(PlayerLoopTiming.LastPostLateUpdate). Equivalent for coroutine's WaitForEndOfFrame requires MonoBehaviour(runner of Coroutine).")]
public static YieldAwaitable WaitForEndOfFrame()
  Returns
WaitForEndOfFrame(CancellationToken, bool)
[Obsolete("Use WaitForEndOfFrame(MonoBehaviour) instead or UniTask.Yield(PlayerLoopTiming.LastPostLateUpdate). Equivalent for coroutine's WaitForEndOfFrame requires MonoBehaviour(runner of Coroutine).")]
public static UniTask WaitForEndOfFrame(CancellationToken cancellationToken, bool cancelImmediately = false)
  Parameters
cancellationTokenCancellationTokencancelImmediatelybool
Returns
WaitForEndOfFrame(MonoBehaviour)
public static UniTask WaitForEndOfFrame(MonoBehaviour coroutineRunner)
  Parameters
coroutineRunnerMonoBehaviour
Returns
WaitForEndOfFrame(MonoBehaviour, CancellationToken, bool)
public static UniTask WaitForEndOfFrame(MonoBehaviour coroutineRunner, CancellationToken cancellationToken, bool cancelImmediately = false)
  Parameters
coroutineRunnerMonoBehaviourcancellationTokenCancellationTokencancelImmediatelybool
Returns
WaitForFixedUpdate()
public static YieldAwaitable WaitForFixedUpdate()
  Returns
WaitForFixedUpdate(CancellationToken, bool)
public static UniTask WaitForFixedUpdate(CancellationToken cancellationToken, bool cancelImmediately = false)
  Parameters
cancellationTokenCancellationTokencancelImmediatelybool
Returns
WaitForSeconds(int, bool, PlayerLoopTiming, CancellationToken, bool)
public static UniTask WaitForSeconds(int duration, bool ignoreTimeScale = false, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
durationintignoreTimeScalebooldelayTimingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
WaitForSeconds(float, bool, PlayerLoopTiming, CancellationToken, bool)
public static UniTask WaitForSeconds(float duration, bool ignoreTimeScale = false, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
durationfloatignoreTimeScalebooldelayTimingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
WaitUntil(Func<bool>, PlayerLoopTiming, CancellationToken, bool)
public static UniTask WaitUntil(Func<bool> predicate, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
predicateFunc<bool>timingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
WaitUntilCanceled(CancellationToken, PlayerLoopTiming, bool)
public static UniTask WaitUntilCanceled(CancellationToken cancellationToken, PlayerLoopTiming timing = PlayerLoopTiming.Update, bool completeImmediately = false)
  Parameters
cancellationTokenCancellationTokentimingPlayerLoopTimingcompleteImmediatelybool
Returns
WaitUntilValueChanged<T, U>(T, Func<T, U>, PlayerLoopTiming, IEqualityComparer<U>, CancellationToken, bool)
public static UniTask<U> WaitUntilValueChanged<T, U>(T target, Func<T, U> monitorFunction, PlayerLoopTiming monitorTiming = PlayerLoopTiming.Update, IEqualityComparer<U> equalityComparer = null, CancellationToken cancellationToken = default, bool cancelImmediately = false) where T : class
  Parameters
targetTmonitorFunctionFunc<T, U>monitorTimingPlayerLoopTimingequalityComparerIEqualityComparer<U>cancellationTokenCancellationTokencancelImmediatelybool
Returns
- UniTask<U>
 
Type Parameters
TU
WaitUntil<T>(T, Func<T, bool>, PlayerLoopTiming, CancellationToken, bool)
public static UniTask WaitUntil<T>(T state, Func<T, bool> predicate, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
stateTpredicateFunc<T, bool>timingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
Type Parameters
T
WaitWhile(Func<bool>, PlayerLoopTiming, CancellationToken, bool)
public static UniTask WaitWhile(Func<bool> predicate, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
predicateFunc<bool>timingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
WaitWhile<T>(T, Func<T, bool>, PlayerLoopTiming, CancellationToken, bool)
public static UniTask WaitWhile<T>(T state, Func<T, bool> predicate, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = default, bool cancelImmediately = false)
  Parameters
stateTpredicateFunc<T, bool>timingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
Type Parameters
T
WhenAll(params UniTask[])
public static UniTask WhenAll(params UniTask[] tasks)
  Parameters
tasksUniTask[]
Returns
WhenAll(IEnumerable<UniTask>)
public static UniTask WhenAll(IEnumerable<UniTask> tasks)
  Parameters
tasksIEnumerable<UniTask>
Returns
WhenAll<T>(params UniTask<T>[])
public static UniTask<T[]> WhenAll<T>(params UniTask<T>[] tasks)
  Parameters
tasksUniTask<T>[]
Returns
- UniTask<T[]>
 
Type Parameters
T
WhenAll<T>(IEnumerable<UniTask<T>>)
public static UniTask<T[]> WhenAll<T>(IEnumerable<UniTask<T>> tasks)
  Parameters
tasksIEnumerable<UniTask<T>>
Returns
- UniTask<T[]>
 
Type Parameters
T
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)>
 
Type Parameters
T1T2T3T4T5T6T7T8T9T10
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)>
 
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)>
 
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>, UniTask<T13>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12, UniTask<T13> task13)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)>
 
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12T13
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>, UniTask<T13>, UniTask<T14>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12, UniTask<T13> task13, UniTask<T14> task14)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)>
 
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12T13T14
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>, UniTask<T13>, UniTask<T14>, UniTask<T15>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12, UniTask<T13> task13, UniTask<T14> task14, UniTask<T15> task15)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)>
 
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12T13T14T15
WhenAll<T1, T2>(UniTask<T1>, UniTask<T2>)
public static UniTask<(T1, T2)> WhenAll<T1, T2>(UniTask<T1> task1, UniTask<T2> task2)
  Parameters
Returns
- UniTask<(T1, T2)>
 
Type Parameters
T1T2
WhenAll<T1, T2, T3>(UniTask<T1>, UniTask<T2>, UniTask<T3>)
public static UniTask<(T1, T2, T3)> WhenAll<T1, T2, T3>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3)
  Parameters
Returns
- UniTask<(T1, T2, T3)>
 
Type Parameters
T1T2T3
WhenAll<T1, T2, T3, T4>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>)
public static UniTask<(T1, T2, T3, T4)> WhenAll<T1, T2, T3, T4>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4)>
 
Type Parameters
T1T2T3T4
WhenAll<T1, T2, T3, T4, T5>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>)
public static UniTask<(T1, T2, T3, T4, T5)> WhenAll<T1, T2, T3, T4, T5>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5)>
 
Type Parameters
T1T2T3T4T5
WhenAll<T1, T2, T3, T4, T5, T6>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>)
public static UniTask<(T1, T2, T3, T4, T5, T6)> WhenAll<T1, T2, T3, T4, T5, T6>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6)>
 
Type Parameters
T1T2T3T4T5T6
WhenAll<T1, T2, T3, T4, T5, T6, T7>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7)> WhenAll<T1, T2, T3, T4, T5, T6, T7>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7)>
 
Type Parameters
T1T2T3T4T5T6T7
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8)>
 
Type Parameters
T1T2T3T4T5T6T7T8
WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>)
public static UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9)> WhenAll<T1, T2, T3, T4, T5, T6, T7, T8, T9>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9)
  Parameters
Returns
- UniTask<(T1, T2, T3, T4, T5, T6, T7, T8, T9)>
 
Type Parameters
T1T2T3T4T5T6T7T8T9
WhenAny(params UniTask[])
public static UniTask<int> WhenAny(params UniTask[] tasks)
  Parameters
tasksUniTask[]
Returns
WhenAny(IEnumerable<UniTask>)
public static UniTask<int> WhenAny(IEnumerable<UniTask> tasks)
  Parameters
tasksIEnumerable<UniTask>
Returns
WhenAny<T>(UniTask<T>, UniTask)
public static UniTask<(bool hasResultLeft, T result)> WhenAny<T>(UniTask<T> leftTask, UniTask rightTask)
  Parameters
Returns
- UniTask<(bool hasResultLeft, T result)>
 
Type Parameters
T
WhenAny<T>(params UniTask<T>[])
public static UniTask<(int winArgumentIndex, T result)> WhenAny<T>(params UniTask<T>[] tasks)
  Parameters
tasksUniTask<T>[]
Returns
- UniTask<(int winArgumentIndex, T result)>
 
Type Parameters
T
WhenAny<T>(IEnumerable<UniTask<T>>)
public static UniTask<(int winArgumentIndex, T result)> WhenAny<T>(IEnumerable<UniTask<T>> tasks)
  Parameters
tasksIEnumerable<UniTask<T>>
Returns
- UniTask<(int winArgumentIndex, T result)>
 
Type Parameters
T
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8, T9 result9, T10 result10)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8T9T10
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8, T9 result9, T10 result10, T11 result11)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8, T9 result9, T10 result10, T11 result11, T12 result12)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>, UniTask<T13>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8, T9 result9, T10 result10, T11 result11, T12 result12, T13 result13)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12, UniTask<T13> task13)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12T13
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>, UniTask<T13>, UniTask<T14>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8, T9 result9, T10 result10, T11 result11, T12 result12, T13 result13, T14 result14)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12, UniTask<T13> task13, UniTask<T14> task14)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12T13T14
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>, UniTask<T10>, UniTask<T11>, UniTask<T12>, UniTask<T13>, UniTask<T14>, UniTask<T15>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8, T9 result9, T10 result10, T11 result11, T12 result12, T13 result13, T14 result14, T15 result15)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9, UniTask<T10> task10, UniTask<T11> task11, UniTask<T12> task12, UniTask<T13> task13, UniTask<T14> task14, UniTask<T15> task15)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8T9T10T11T12T13T14T15
WhenAny<T1, T2>(UniTask<T1>, UniTask<T2>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2)> WhenAny<T1, T2>(UniTask<T1> task1, UniTask<T2> task2)
  Parameters
Returns
- UniTask<(int winArgumentIndex, T1 result1, T2 result2)>
 
Type Parameters
T1T2
WhenAny<T1, T2, T3>(UniTask<T1>, UniTask<T2>, UniTask<T3>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3)> WhenAny<T1, T2, T3>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3)
  Parameters
Returns
Type Parameters
T1T2T3
WhenAny<T1, T2, T3, T4>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4)> WhenAny<T1, T2, T3, T4>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4)
  Parameters
Returns
Type Parameters
T1T2T3T4
WhenAny<T1, T2, T3, T4, T5>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5)> WhenAny<T1, T2, T3, T4, T5>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5)
  Parameters
Returns
Type Parameters
T1T2T3T4T5
WhenAny<T1, T2, T3, T4, T5, T6>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6)> WhenAny<T1, T2, T3, T4, T5, T6>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6
WhenAny<T1, T2, T3, T4, T5, T6, T7>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7)> WhenAny<T1, T2, T3, T4, T5, T6, T7>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8
WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9>(UniTask<T1>, UniTask<T2>, UniTask<T3>, UniTask<T4>, UniTask<T5>, UniTask<T6>, UniTask<T7>, UniTask<T8>, UniTask<T9>)
public static UniTask<(int winArgumentIndex, T1 result1, T2 result2, T3 result3, T4 result4, T5 result5, T6 result6, T7 result7, T8 result8, T9 result9)> WhenAny<T1, T2, T3, T4, T5, T6, T7, T8, T9>(UniTask<T1> task1, UniTask<T2> task2, UniTask<T3> task3, UniTask<T4> task4, UniTask<T5> task5, UniTask<T6> task6, UniTask<T7> task7, UniTask<T8> task8, UniTask<T9> task9)
  Parameters
Returns
Type Parameters
T1T2T3T4T5T6T7T8T9
WhenEach<T>(params UniTask<T>[])
public static IUniTaskAsyncEnumerable<WhenEachResult<T>> WhenEach<T>(params UniTask<T>[] tasks)
  Parameters
tasksUniTask<T>[]
Returns
Type Parameters
T
WhenEach<T>(IEnumerable<UniTask<T>>)
public static IUniTaskAsyncEnumerable<WhenEachResult<T>> WhenEach<T>(IEnumerable<UniTask<T>> tasks)
  Parameters
tasksIEnumerable<UniTask<T>>
Returns
Type Parameters
T
Yield()
public static YieldAwaitable Yield()
  Returns
Yield(PlayerLoopTiming)
public static YieldAwaitable Yield(PlayerLoopTiming timing)
  Parameters
timingPlayerLoopTiming
Returns
Yield(PlayerLoopTiming, CancellationToken, bool)
public static UniTask Yield(PlayerLoopTiming timing, CancellationToken cancellationToken, bool cancelImmediately = false)
  Parameters
timingPlayerLoopTimingcancellationTokenCancellationTokencancelImmediatelybool
Returns
Yield(CancellationToken, bool)
public static UniTask Yield(CancellationToken cancellationToken, bool cancelImmediately = false)
  Parameters
cancellationTokenCancellationTokencancelImmediatelybool
Returns
Operators
implicit operator ValueTask(in UniTask)
public static implicit operator ValueTask(in UniTask self)
  Parameters
selfUniTask