269 lines
13 KiB
C#
269 lines
13 KiB
C#
/*
|
|
Yarn Spinner is licensed to you under the terms found in the file LICENSE.md.
|
|
*/
|
|
|
|
// If we don't already have a directive telling us what to use...
|
|
#if !YARNTASKS_ARE_AWAITABLES && !YARNTASKS_ARE_SYSTEMTASKS && !YARNTASKS_ARE_UNITASKS
|
|
// ...then figure out what the best option is. We'll try to use UniTask, if
|
|
// installed; then Awaitables, if >= Unity 2023.1; then System.Threading.Tasks.
|
|
#if USE_UNITASK
|
|
#define YARNTASKS_ARE_UNITASKS
|
|
#elif UNITY_2023_1_OR_NEWER
|
|
#define YARNTASKS_ARE_AWAITABLES
|
|
#else
|
|
#define YARNTASKS_ARE_SYSTEMTASKS
|
|
#endif
|
|
#endif
|
|
|
|
#if YARNTASKS_ARE_UNITASKS
|
|
namespace Yarn.Unity
|
|
{
|
|
|
|
using Cysharp.Threading.Tasks;
|
|
using System;
|
|
using System.Collections;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
|
|
#if USE_ADDRESSABLES
|
|
using UnityEngine.ResourceManagement.AsyncOperations;
|
|
#endif
|
|
|
|
public partial struct YarnTask
|
|
{
|
|
public UniTask.Awaiter GetAwaiter() => Task.GetAwaiter();
|
|
|
|
UniTask Task;
|
|
readonly public bool IsCompleted() => Task.Status != UniTaskStatus.Pending;
|
|
readonly public bool IsCompletedSuccessfully() => Task.Status == UniTaskStatus.Succeeded;
|
|
|
|
public static YarnTask CompletedTask => UniTask.CompletedTask;
|
|
|
|
public static implicit operator UniTask(YarnTask demoYarnTask)
|
|
{
|
|
return demoYarnTask.Task;
|
|
}
|
|
|
|
public static implicit operator YarnTask(UniTask task)
|
|
{
|
|
return new YarnTask { Task = task };
|
|
}
|
|
|
|
public static implicit operator YarnTask(System.Threading.Tasks.Task task)
|
|
{
|
|
return new YarnTask { Task = task.AsUniTask() };
|
|
}
|
|
|
|
#if UNITY_2023_1_OR_NEWER
|
|
// Allow implicitly converting Awaitables to YarnTasks
|
|
public static implicit operator YarnTask(UnityEngine.Awaitable awaitable)
|
|
{
|
|
return new YarnTask { Task = awaitable.AsUniTask() };
|
|
}
|
|
#endif
|
|
|
|
readonly public void Forget() => Task.Forget();
|
|
|
|
public static partial YarnTask WaitUntilCanceled(System.Threading.CancellationToken token)
|
|
{
|
|
return UniTask.WaitUntilCanceled(token);
|
|
}
|
|
|
|
public static partial YarnTask Delay(TimeSpan timeSpan, CancellationToken token)
|
|
{
|
|
return UniTask.Delay(timeSpan, cancellationToken: token);
|
|
}
|
|
|
|
public static partial YarnTask WaitUntil(System.Func<bool> predicate, System.Threading.CancellationToken token)
|
|
{
|
|
return UniTask.WaitUntil(predicate, cancellationToken: token);
|
|
}
|
|
|
|
public static partial IEnumerator ToCoroutine(Func<YarnTask> factory)
|
|
{
|
|
return UniTask.ToCoroutine(async () => await factory());
|
|
}
|
|
|
|
public static partial async YarnTask Yield() => await UniTask.Yield();
|
|
|
|
public static partial YarnTask WhenAll(params YarnTask[] tasks)
|
|
{
|
|
return WhenAll((IEnumerable<YarnTask>)tasks);
|
|
}
|
|
public static partial async YarnTask WhenAll(IEnumerable<YarnTask> tasks)
|
|
{
|
|
// Don't love this allocation here; try and find a better approach
|
|
List<UniTask> taskList = new List<UniTask>();
|
|
foreach (var task in tasks)
|
|
{
|
|
taskList.Add(task);
|
|
}
|
|
|
|
await UniTask.WhenAll(taskList.ToArray());
|
|
|
|
}
|
|
|
|
public static async partial YarnTask<T[]> WhenAll<T>(params YarnTask<T>[] tasks)
|
|
{
|
|
return await UniTask.WhenAll(Array.ConvertAll<YarnTask<T>, UniTask<T>>(tasks, t => t));
|
|
}
|
|
|
|
public static async partial YarnTask<T[]> WhenAll<T>(IEnumerable<YarnTask<T>> tasks)
|
|
{
|
|
var uniTasks = new List<UniTask<T>>();
|
|
foreach (var task in tasks)
|
|
{
|
|
uniTasks.Add(task);
|
|
}
|
|
return await UniTask.WhenAll(uniTasks);
|
|
|
|
}
|
|
|
|
#if USE_ADDRESSABLES
|
|
public static partial async YarnTask WaitForAsyncOperation(AsyncOperationHandle operationHandle, CancellationToken cancellationToken)
|
|
{
|
|
await operationHandle.ToUniTask(cancellationToken: cancellationToken);
|
|
}
|
|
|
|
public static partial async YarnTask<T> WaitForAsyncOperation<T>(AsyncOperationHandle<T> operationHandle, CancellationToken cancellationToken)
|
|
{
|
|
return await operationHandle.ToUniTask(cancellationToken: cancellationToken);
|
|
}
|
|
#endif
|
|
|
|
public readonly partial async YarnTask<bool> SuppressCancellationThrow()
|
|
{
|
|
try
|
|
{
|
|
await Task;
|
|
}
|
|
catch (OperationCanceledException)
|
|
{
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
public partial struct YarnTask<T>
|
|
{
|
|
UniTask<T> Task;
|
|
public UniTask<T>.Awaiter GetAwaiter() => Task.GetAwaiter();
|
|
|
|
readonly public bool IsCompleted() => Task.Status != UniTaskStatus.Pending;
|
|
readonly public bool IsCompletedSuccessfully() => Task.Status == UniTaskStatus.Succeeded;
|
|
|
|
public static implicit operator UniTask<T>(YarnTask<T> demoYarnTask)
|
|
{
|
|
return demoYarnTask.Task;
|
|
}
|
|
|
|
public static implicit operator YarnTask<T>(UniTask<T> task)
|
|
{
|
|
return new YarnTask<T> { Task = task };
|
|
}
|
|
|
|
#if UNITY_2023_1_OR_NEWER
|
|
// Allow implicitly converting Awaitables to YarnTasks
|
|
public static implicit operator YarnTask<T>(UnityEngine.Awaitable<T> awaitable)
|
|
{
|
|
return new YarnTask<T> { Task = awaitable.AsUniTask() };
|
|
}
|
|
#endif
|
|
|
|
|
|
readonly public void Forget() => Task.Forget();
|
|
|
|
public static partial YarnTask<T> FromResult(T value)
|
|
{
|
|
return UniTask.FromResult(value);
|
|
}
|
|
}
|
|
|
|
|
|
public partial class YarnTaskCompletionSource
|
|
{
|
|
private UniTaskCompletionSource awaitableCompletionSource = new();
|
|
public partial bool TrySetResult()
|
|
{
|
|
return awaitableCompletionSource.TrySetResult();
|
|
}
|
|
|
|
public partial bool TrySetException(System.Exception exception)
|
|
{
|
|
return awaitableCompletionSource.TrySetException(exception);
|
|
}
|
|
|
|
public partial bool TrySetCanceled()
|
|
{
|
|
return awaitableCompletionSource.TrySetCanceled();
|
|
}
|
|
|
|
public YarnTask Task => awaitableCompletionSource.Task;
|
|
}
|
|
|
|
public partial class YarnTaskCompletionSource<T>
|
|
{
|
|
private UniTaskCompletionSource<T> awaitableCompletionSource = new();
|
|
public partial bool TrySetResult(T value)
|
|
{
|
|
return awaitableCompletionSource.TrySetResult(value);
|
|
}
|
|
|
|
public partial bool TrySetException(System.Exception exception)
|
|
{
|
|
return awaitableCompletionSource.TrySetException(exception);
|
|
}
|
|
|
|
public partial bool TrySetCanceled()
|
|
{
|
|
return awaitableCompletionSource.TrySetCanceled();
|
|
}
|
|
public YarnTask<T> Task => awaitableCompletionSource.Task;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Contains extension methods for <see cref="IActionRegistration"/>
|
|
/// objects.
|
|
/// </summary>
|
|
public static class ActionRegistrationUniTaskExtension
|
|
{
|
|
// These registrations for UniTask were generated by action-gyb.py
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler(this IActionRegistration registration, string commandName, System.Func<UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1>(this IActionRegistration registration, string commandName, System.Func<T1, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2>(this IActionRegistration registration, string commandName, System.Func<T1, T2, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
/// <inheritdoc cref="IActionRegistration.AddCommandHandler(string, Delegate)"/>
|
|
public static void AddCommandHandler<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16>(this IActionRegistration registration, string commandName, System.Func<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, UniTask> handler) => registration.AddCommandHandler(commandName, (Delegate)handler);
|
|
}
|
|
}
|
|
#endif
|