UniTask Struct
Namespace: Cysharp.Threading.Tasks
Assembly: cs.temp.dll.dll
Lightweight unity specified task-like object.
public struct UniTask
Members
Constructors
| Name | Description |
|---|---|
| UniTask(IUniTaskSource, Int16) |
Fields
| Name | Description |
|---|---|
| CompletedTask |
Properties
| Name | Description |
|---|---|
| Status |
Methods
Operators
| Name | Description |
|---|---|
| Implicit(UniTask to ValueTask) |
Constructors
UniTask(IUniTaskSource, Int16)
public UniTask(IUniTaskSource source, short token)
Parameters
sourceIUniTaskSourcetokenSystem.Int16
Fields
CompletedTask
public static readonly UniTask CompletedTask
Field Value
Properties
Status
public UniTaskStatus Status { get; }
Property Value
Methods
Action(Func<CancellationToken, UniTaskVoid>, CancellationToken)
helper of create add UniTaskVoid to delegate.
public static Action Action(Func<CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
Parameters
asyncActionSystem.Func<CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Returns
- System.Action
Action(Func<UniTaskVoid>)
helper of create add UniTaskVoid to delegate. For example: FooAction = UniTask.Action(async () => { /* */ })
public static Action Action(Func<UniTaskVoid> asyncAction)
Parameters
asyncActionSystem.Func<UniTaskVoid>
Returns
- System.Action
AsAsyncUnitUniTask()
public UniTask<AsyncUnit> AsAsyncUnitUniTask()
Returns
Create(Func<UniTask>)
public static UniTask Create(Func<UniTask> factory)
Parameters
factorySystem.Func<UniTask>
Returns
Create<T>(Func<UniTask<T>>)
public static UniTask<T> Create<T>(Func<UniTask<T>> factory)
Parameters
factorySystem.Func<UniTask<T>>
Returns
- UniTask<T>
Type Parameters
T
Defer(Func<UniTask>)
Defer the task creation just before call await.
public static UniTask Defer(Func<UniTask> factory)
Parameters
factorySystem.Func<UniTask>
Returns
Defer<T>(Func<UniTask<T>>)
Defer the task creation just before call await.
public static UniTask<T> Defer<T>(Func<UniTask<T>> factory)
Parameters
factorySystem.Func<UniTask<T>>
Returns
- UniTask<T>
Type Parameters
T
Delay(Int32, DelayType, PlayerLoopTiming, CancellationToken)
public static UniTask Delay(int millisecondsDelay, DelayType delayType, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
millisecondsDelaySystem.Int32delayTypeDelayTypedelayTimingPlayerLoopTimingcancellationTokenCancellationToken
Returns
Delay(Int32, Boolean, PlayerLoopTiming, CancellationToken)
public static UniTask Delay(int millisecondsDelay, bool ignoreTimeScale = false, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
millisecondsDelaySystem.Int32ignoreTimeScaleSystem.BooleandelayTimingPlayerLoopTimingcancellationTokenCancellationToken
Returns
Delay(TimeSpan, DelayType, PlayerLoopTiming, CancellationToken)
public static UniTask Delay(TimeSpan delayTimeSpan, DelayType delayType, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
delayTimeSpanSystem.TimeSpandelayTypeDelayTypedelayTimingPlayerLoopTimingcancellationTokenCancellationToken
Returns
Delay(TimeSpan, Boolean, PlayerLoopTiming, CancellationToken)
public static UniTask Delay(TimeSpan delayTimeSpan, bool ignoreTimeScale = false, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
delayTimeSpanSystem.TimeSpanignoreTimeScaleSystem.BooleandelayTimingPlayerLoopTimingcancellationTokenCancellationToken
Returns
DelayFrame(Int32, PlayerLoopTiming, CancellationToken)
public static UniTask DelayFrame(int delayFrameCount, PlayerLoopTiming delayTiming = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
delayFrameCountSystem.Int32delayTimingPlayerLoopTimingcancellationTokenCancellationToken
Returns
FromCanceled(CancellationToken)
public static UniTask FromCanceled(CancellationToken cancellationToken = null)
Parameters
cancellationTokenCancellationToken
Returns
FromCanceled<T>(CancellationToken)
public static UniTask<T> FromCanceled<T>(CancellationToken cancellationToken = null)
Parameters
cancellationTokenCancellationToken
Returns
- UniTask<T>
Type Parameters
T
FromException(Exception)
public static UniTask FromException(Exception ex)
Parameters
exSystem.Exception
Returns
FromException<T>(Exception)
public static UniTask<T> FromException<T>(Exception ex)
Parameters
exSystem.Exception
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
factorySystem.Func<UniTask>
Returns
Lazy<T>(Func<UniTask<T>>)
public static AsyncLazy<T> Lazy<T>(Func<UniTask<T>> factory)
Parameters
factorySystem.Func<UniTask<T>>
Returns
- AsyncLazy<T>
Type Parameters
T
Never(CancellationToken)
Never complete.
public static UniTask Never(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationToken
Returns
Never<T>(CancellationToken)
Never complete.
public static UniTask<T> Never<T>(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationToken
Returns
- UniTask<T>
Type Parameters
T
NextFrame(PlayerLoopTiming, CancellationToken)
Similar as UniTask.Yield but guaranteed run on next frame.
public static UniTask NextFrame(PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
timingPlayerLoopTimingcancellationTokenCancellationToken
Returns
Preserve()
Memoizing inner IValueTaskSource. The result UniTask can await multiple.
public UniTask Preserve()
Returns
ReturnToCurrentSynchronizationContext(Boolean, CancellationToken)
public static ReturnToSynchronizationContext ReturnToCurrentSynchronizationContext(bool dontPostWhenSameContext = true, CancellationToken cancellationToken = null)
Parameters
dontPostWhenSameContextSystem.BooleancancellationTokenCancellationToken
Returns
ReturnToSynchronizationContext(SynchronizationContext, CancellationToken)
public static ReturnToSynchronizationContext ReturnToSynchronizationContext(SynchronizationContext synchronizationContext, CancellationToken cancellationToken = null)
Parameters
synchronizationContextSynchronizationContextcancellationTokenCancellationToken
Returns
Run(Action, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask Run(Action action, bool configureAwait = true)
Parameters
actionSystem.ActionconfigureAwaitSystem.Boolean
Returns
Run(Action<Object>, Object, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask Run(Action<object> action, object state, bool configureAwait = true)
Parameters
actionSystem.Action<System.Object>stateSystem.ObjectconfigureAwaitSystem.Boolean
Returns
Run(Func<UniTask>, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask Run(Func<UniTask> action, bool configureAwait = true)
Parameters
actionSystem.Func<UniTask>configureAwaitSystem.Boolean
Returns
Run(Func<Object, UniTask>, Object, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask Run(Func<object, UniTask> action, object state, bool configureAwait = true)
Parameters
actionSystem.Func<System.Object, UniTask>stateSystem.ObjectconfigureAwaitSystem.Boolean
Returns
Run<T>(Func<T>, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask<T> Run<T>(Func<T> func, bool configureAwait = true)
Parameters
funcSystem.Func<T>configureAwaitSystem.Boolean
Returns
- UniTask<T>
Type Parameters
T
Run<T>(Func<UniTask<T>>, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask<T> Run<T>(Func<UniTask<T>> func, bool configureAwait = true)
Parameters
funcSystem.Func<UniTask<T>>configureAwaitSystem.Boolean
Returns
- UniTask<T>
Type Parameters
T
Run<T>(Func<Object, T>, Object, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask<T> Run<T>(Func<object, T> func, object state, bool configureAwait = true)
Parameters
funcSystem.Func<System.Object, T>stateSystem.ObjectconfigureAwaitSystem.Boolean
Returns
- UniTask<T>
Type Parameters
T
Run<T>(Func<Object, UniTask<T>>, Object, Boolean)
Run action on the threadPool and return to main thread if configureAwait = true.
public static UniTask<T> Run<T>(Func<object, UniTask<T>> func, object state, bool configureAwait = true)
Parameters
funcSystem.Func<System.Object, UniTask<T>>stateSystem.ObjectconfigureAwaitSystem.Boolean
Returns
- UniTask<T>
Type Parameters
T
SuppressCancellationThrow()
returns (bool IsCanceled) instead of throws OperationCanceledException.
public UniTask<bool> SuppressCancellationThrow()
Returns
- UniTask<System.Boolean>
SwitchToSynchronizationContext(SynchronizationContext, CancellationToken)
public static SwitchToSynchronizationContextAwaitable SwitchToSynchronizationContext(SynchronizationContext synchronizationContext, CancellationToken cancellationToken = null)
Parameters
synchronizationContextSynchronizationContextcancellationTokenCancellationToken
Returns
SwitchToTaskPool()
Note: use SwitchToThreadPool is recommended.
public static SwitchToTaskPoolAwaitable SwitchToTaskPool()
Returns
SwitchToThreadPool()
public static SwitchToThreadPoolAwaitable SwitchToThreadPool()
Returns
ToCoroutine(Func<UniTask>)
public static IEnumerator ToCoroutine(Func<UniTask> taskFactory)
Parameters
taskFactorySystem.Func<UniTask>
Returns
- IEnumerator
ToString()
public override string ToString()
Returns
- System.String
Overrides
Void(Func<CancellationToken, UniTaskVoid>, CancellationToken)
helper of fire and forget void action.
public static void Void(Func<CancellationToken, UniTaskVoid> asyncAction, CancellationToken cancellationToken)
Parameters
asyncActionSystem.Func<CancellationToken, UniTaskVoid>cancellationTokenCancellationToken
Void(Func<UniTaskVoid>)
helper of fire and forget void action.
public static void Void(Func<UniTaskVoid> asyncAction)
Parameters
asyncActionSystem.Func<UniTaskVoid>
Void<T>(Func<T, UniTaskVoid>, T)
helper of fire and forget void action.
public static void Void<T>(Func<T, UniTaskVoid> asyncAction, T state)
Parameters
asyncActionSystem.Func<T, UniTaskVoid>stateT
Type Parameters
T
WaitForEndOfFrame()
Same as UniTask.Yield(PlayerLoopTiming.LastPostLateUpdate).
public static YieldAwaitable WaitForEndOfFrame()
Returns
WaitForEndOfFrame(CancellationToken)
Same as UniTask.Yield(PlayerLoopTiming.LastPostLateUpdate, cancellationToken).
public static UniTask WaitForEndOfFrame(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationToken
Returns
WaitForFixedUpdate()
Same as UniTask.Yield(PlayerLoopTiming.FixedUpdate).
public static YieldAwaitable WaitForFixedUpdate()
Returns
WaitForFixedUpdate(CancellationToken)
Same as UniTask.Yield(PlayerLoopTiming.FixedUpdate, cancellationToken).
public static UniTask WaitForFixedUpdate(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationToken
Returns
WaitUntil(Func<Boolean>, PlayerLoopTiming, CancellationToken)
public static UniTask WaitUntil(Func<bool> predicate, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
predicateSystem.Func<System.Boolean>timingPlayerLoopTimingcancellationTokenCancellationToken
Returns
WaitUntilCanceled(CancellationToken, PlayerLoopTiming)
public static UniTask WaitUntilCanceled(CancellationToken cancellationToken, PlayerLoopTiming timing = PlayerLoopTiming.Update)
Parameters
cancellationTokenCancellationTokentimingPlayerLoopTiming
Returns
WaitUntilValueChanged<T, U>(T, Func<T, U>, PlayerLoopTiming, IEqualityComparer<U>, CancellationToken)
public static UniTask<U> WaitUntilValueChanged<T, U>(T target, Func<T, U> monitorFunction, PlayerLoopTiming monitorTiming = PlayerLoopTiming.Update, IEqualityComparer<U> equalityComparer = null, CancellationToken cancellationToken = null)
where T : class
Parameters
targetTmonitorFunctionSystem.Func<T, U>monitorTimingPlayerLoopTimingequalityComparerIEqualityComparer<U>cancellationTokenCancellationToken
Returns
- UniTask<U>
Type Parameters
TU
WaitWhile(Func<Boolean>, PlayerLoopTiming, CancellationToken)
public static UniTask WaitWhile(Func<bool> predicate, PlayerLoopTiming timing = PlayerLoopTiming.Update, CancellationToken cancellationToken = null)
Parameters
predicateSystem.Func<System.Boolean>timingPlayerLoopTimingcancellationTokenCancellationToken
Returns
WhenAll(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>(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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<T8, T9, T10, T11, T12, T13, T14, System.ValueTuple<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<System.ValueTuple<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<System.ValueTuple<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<System.ValueTuple<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<System.ValueTuple<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<System.ValueTuple<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<System.ValueTuple<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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<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<System.ValueTuple<T1, T2, T3, T4, T5, T6, T7, System.ValueTuple<T8, T9>>>
Type Parameters
T1T2T3T4T5T6T7T8T9
WhenAny(UniTask[])
Return value is winArgumentIndex
public static UniTask<int> WhenAny(params UniTask[] tasks)
Parameters
tasksUniTask[]
Returns
- UniTask<System.Int32>
WhenAny(IEnumerable<UniTask>)
Return value is winArgumentIndex
public static UniTask<int> WhenAny(IEnumerable<UniTask> tasks)
Parameters
tasksIEnumerable<UniTask>
Returns
- UniTask<System.Int32>
WhenAny<T>(UniTask<T>, UniTask)
public static UniTask<(bool hasResultLeft, T result)> WhenAny<T>(UniTask<T> leftTask, UniTask rightTask)
Parameters
Returns
- UniTask<System.ValueTuple<System.Boolean, T>>
Type Parameters
T
WhenAny<T>(UniTask<T>[])
public static UniTask<(int winArgumentIndex, T result)> WhenAny<T>(params UniTask<T>[] tasks)
Parameters
tasksUniTask<T>[]
Returns
- UniTask<System.ValueTuple<System.Int32, T>>
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<System.ValueTuple<System.Int32, T>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8, T9, T10>>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8, T9, T10, T11>>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8, T9, T10, T11, T12>>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8, T9, T10, T11, T12, T13>>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8, T9, T10, T11, T12, T13, System.ValueTuple<T14>>>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8, T9, T10, T11, T12, T13, System.ValueTuple<T14, T15>>>>
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<System.ValueTuple<System.Int32, T1, T2>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7>>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8>>>
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
- UniTask<System.ValueTuple<System.Int32, T1, T2, T3, T4, T5, T6, System.ValueTuple<T7, T8, T9>>>
Type Parameters
T1T2T3T4T5T6T7T8T9
Yield(PlayerLoopTiming)
public static YieldAwaitable Yield(PlayerLoopTiming timing = PlayerLoopTiming.Update)
Parameters
timingPlayerLoopTiming
Returns
Yield(PlayerLoopTiming, CancellationToken)
public static UniTask Yield(PlayerLoopTiming timing, CancellationToken cancellationToken)
Parameters
timingPlayerLoopTimingcancellationTokenCancellationToken
Returns
Operators
Implicit(UniTask to ValueTask)
public static implicit operator ValueTask(in UniTask self)
Parameters
selfUniTask
Returns
- System.Threading.Tasks.ValueTask