Merge pull request #30 from AkiKurisu/dev

Merge Dev 1.1.1 features and bug fix

Docs/Animations.md

@@ -0,0 +1,50 @@
+# Animations
+
+Create dynamic animation sequence and cutscene from script based on Playables.
+
+## Features
+
+- Crossfade multi `RuntimeAnimatorController` and `AnimationClip`.
+
+## AnimationProxy Example
+
+```C#
+public class MontageExample : MonoBehaviour
+{
+    public Animator animator;
+    private AnimationProxy animationProxy;
+    public RuntimeAnimatorController controllerA;
+    public RuntimeAnimatorController controllerB;
+    private IEnumerator Start()
+    {
+        animationProxy = new AnimationProxy(animator);
+        animationProxy.LoadAnimator(controllerA, 0.5f); /* Crossfade  animator to controllerA in 0.5s */
+        yield return new WaitForSeconds(1f);
+        animationProxy.LoadAnimator(controllerB, 0.5f); /* Crossfade  controllerA to controllerB in 0.5s */
+        yield return new WaitForSeconds(1f);
+        chaAnimationProxy.Stop(0.5f); /* Crossfade  controllerB to animator in 0.5s */
+    }
+}
+```
+
+## SequenceBuilder Example
+
+```C#
+public class SequenceExample : MonoBehaviour
+{
+    public Animator animator;
+    private AnimationProxy animationProxy;
+    public AnimationClip[] clips;
+    private void Start()
+    {
+        animationProxy = new AnimationProxy(animator);
+        using var builder = chaAnimationProxy.CreateSequenceBuilder();
+        foreach (var clip in clips)
+        {
+            builder.Append(clip, clip.length * 3 /* Play 3 loop */, 0.25f /* BlendIn duration */);
+        }
+        builder.SetBlendOut(0.5f);
+        builder.Build().Run();
+    }
+}
+```

Docs/Scheduler.md → Docs/Schedulers.md

@@ -1,4 +1,4 @@
-# Scheduler
+# Schedulers
 
 Zero allocation timer/frame counter.
 

Modules/Resource/Editor/SoftAssetReferenceEditorUtils.cs

@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using UObject = UnityEngine.Object;
 using Kurisu.Framework.Serialization;
+using UnityEditor.AddressableAssets.Settings.GroupSchemas;
 namespace Kurisu.Framework.Resource.Editor
 {
     public static class SoftAssetReferenceEditorUtils
@@ -130,7 +131,11 @@ public static AddressableAssetGroup GetOrCreateAssetGroup(string groupName)
         {
             var group = AddressableAssetSettingsDefaultObject.Settings.groups.FirstOrDefault(x => x.name == groupName);
             if (group != null) return group;
-            return AddressableAssetSettingsDefaultObject.Settings.CreateGroup(groupName, false, false, true, AddressableAssetSettingsDefaultObject.Settings.DefaultGroup.Schemas);
+            group = AddressableAssetSettingsDefaultObject.Settings.CreateGroup(groupName, false, false, true, AddressableAssetSettingsDefaultObject.Settings.DefaultGroup.Schemas);
+            // Ensure address is included in build
+            BundledAssetGroupSchema infoSchema = group.GetSchema<BundledAssetGroupSchema>();
+            infoSchema.IncludeAddressInCatalog = true;
+            return group;
         }
         public static AddressableAssetEntry AddAsset(this AddressableAssetGroup group, UObject asset, params string[] labels)
         {

Modules/Resource/Runtime/ResourceCache.cs

@@ -5,12 +5,6 @@
 using Cysharp.Threading.Tasks;
 namespace Kurisu.Framework.Resource
 {
-    public class InvalidResourceRequestException : Exception
-    {
-        public string InvalidAddress { get; }
-        public InvalidResourceRequestException() : base() { }
-        public InvalidResourceRequestException(string address, string message) : base(message) { InvalidAddress = address; }
-    }
     /// <summary>
     /// Loading and cache specific asset as a group and release them by control version
     /// </summary>
@@ -20,15 +14,25 @@ public class ResourceCache<TAsset> : IDisposable, IReadOnlyDictionary<string, TA
         private readonly Dictionary<string, ResourceHandle<TAsset>> internalHandles = new();
         private readonly Dictionary<string, TAsset> cacheMap = new();
         private readonly Dictionary<string, int> versionMap = new();
+
         /// <summary>
         /// Validate asset location before loading, throw <see cref="InvalidResourceRequestException"/> if not exist
         /// </summary>
         /// <value></value>
         public bool AddressSafeCheck { get; set; } = false;
+
+        /// <summary>
+        /// Current cache version
+        /// </summary>
+        /// <value></value>
         public int Version { get; private set; } = 0;
+
         public IEnumerable<string> Keys => cacheMap.Keys;
+
         public IEnumerable<TAsset> Values => cacheMap.Values;
+
         public int Count => cacheMap.Count;
+
         public TAsset this[string key] => cacheMap[key];
 
         /// <summary>

Modules/Resource/Runtime/ResourceSystem.cs

@@ -7,6 +7,15 @@
 using Cysharp.Threading.Tasks;
 namespace Kurisu.Framework.Resource
 {
+    /// <summary>
+    /// Exception thrown when request resource address is invalid
+    /// </summary>
+    public class InvalidResourceRequestException : Exception
+    {
+        public string InvalidAddress { get; }
+        public InvalidResourceRequestException() : base() { }
+        public InvalidResourceRequestException(string address, string message) : base(message) { InvalidAddress = address; }
+    }
     /// <summary>
     /// Resource system that loads resource by address and label based on Addressables.
     /// </summary>
@@ -99,7 +108,7 @@ public static async UniTask SafeCheckAsync<TAsset>(object key)
             if (location.Status != AsyncOperationStatus.Succeeded || location.Result.Count == 0)
             {
                 string stringValue;
-                if (key is IEnumerable<string> list) stringValue = $"[{string.Join(",", list)}]";
+                if (key is IEnumerable<string> list) stringValue = $"[{string.Join(',', list)}]";
                 else stringValue = key.ToString();
                 throw new InvalidResourceRequestException(stringValue, $"Address {stringValue} not valid for loading {typeof(TAsset)} asset");
             }
@@ -118,7 +127,7 @@ public static async UniTask SafeCheckAsync<TAsset>(IEnumerable key, MergeMode me
             if (location.Status != AsyncOperationStatus.Succeeded || location.Result.Count == 0)
             {
                 string stringValue;
-                if (key is IEnumerable<string> list) stringValue = $"[{string.Join(",", list)}]";
+                if (key is IEnumerable<string> list) stringValue = $"[{string.Join(',', list)}]";
                 else stringValue = key.ToString();
                 throw new InvalidResourceRequestException(stringValue, $"Address {stringValue} not valid for loading {typeof(TAsset)} asset");
             }

README.md

@@ -16,7 +16,7 @@ I supposed these code are useful but also not-must-be-included, which is my pers
 [Pool](./Docs/Pool.md) 
 > Zero allocation GameObject/Component pooling. 
 
-[Scheduler](./Docs/Scheduler.md) 
+[Schedulers](./Docs/Schedulers.md) 
 > Zero allocation timer/frame counter. 
 
 [Serialization](./Docs/Serialization.md)
@@ -25,6 +25,9 @@ I supposed these code are useful but also not-must-be-included, which is my pers
 [Data Driven](./Docs/DataDriven.md)
 >Use Unreal-like DataTable workflow in Unity.
 
+[Animations](./Docs/Animations.md)
+>Create dynamic animation sequence and cutscene from script based on Playables.
+
 ## Modules
 
 Modules are based on core features.

Runtime/Core/Events/EventSystem.cs

@@ -1,4 +1,3 @@
-using System.Collections.Generic;
 using UnityEngine;
 namespace Kurisu.Framework.Events
 {

Runtime/Core/Events/Interfaces/IEventCoordinator.cs

@@ -10,5 +10,10 @@ public interface IEventCoordinator
         /// </summary>
         /// <value></value>
         CallbackEventHandler GetCallbackEventHandler();
+        /// <summary>
+        /// Get coordinator's dispatcher
+        /// </summary>
+        /// <value></value>
+        EventDispatcher EventDispatcher { get; }
     }
 }

Runtime/Core/Events/Interfaces/IEventDispatchingStrategy.cs

@@ -61,6 +61,11 @@ public interface IEventDispatchingStrategy
         bool CanDispatchEvent(EventBase evt);
         void DispatchEvent(EventBase evt, IEventCoordinator coordinator);
     }
+    public interface IEventDispatchingListener
+    {
+        void OnPushDispatcherContext();
+        void OnPopDispatcherContext();
+    }
     internal static class EventDispatchUtilities
     {
         public static void PropagateEvent(EventBase evt)

Runtime/Core/Events/Models/EventBase.cs

@@ -353,7 +353,7 @@ private set
         }
 
 
-        internal bool StopDispatch
+        public bool StopDispatch
         {
             get { return (Status & LifeCycleStatus.StopDispatch) != LifeCycleStatus.None; }
             set
@@ -447,7 +447,7 @@ protected bool Pooled
             }
         }
 
-        internal abstract void Acquire();
+        public abstract void Acquire();
         /// <summary>
         /// Implementation of <see cref="IDisposable"/>.
         /// </summary>
@@ -554,7 +554,7 @@ static void ReleasePooled(T evt)
             }
         }
 
-        internal override void Acquire()
+        public override void Acquire()
         {
             m_RefCount++;
         }

Runtime/Core/Events/Models/EventDispatcher.cs

@@ -84,10 +84,11 @@ private struct DispatchContext
             public uint m_GateCount;
             public Queue<EventRecord> m_Queue;
         }
-
+        private readonly List<IEventDispatchingListener> dispatchingListeners;
         private readonly Stack<DispatchContext> m_DispatchContexts = new();
         public EventDispatcher(IList<IEventDispatchingStrategy> strategies)
         {
+            dispatchingListeners = new List<IEventDispatchingListener>();
             m_DispatchingStrategies = new List<IEventDispatchingStrategy>();
 #if UNITY_EDITOR
             m_DebuggerEventDispatchingStrategy = new DebuggerEventDispatchingStrategy();
@@ -136,6 +137,11 @@ public void Dispatch(EventBase evt, IEventCoordinator coordinator, DispatchMode
 
         public void PushDispatcherContext()
         {
+            foreach (var listener in dispatchingListeners)
+            {
+                listener.OnPushDispatcherContext();
+            }
+
             // Drain the event queue before pushing a new context.
             ProcessEventQueue();
 
@@ -154,6 +160,11 @@ public void PopDispatcherContext()
             m_GateCount = m_DispatchContexts.Peek().m_GateCount;
             m_Queue = m_DispatchContexts.Peek().m_Queue;
             m_DispatchContexts.Pop();
+
+            foreach (var listener in dispatchingListeners)
+            {
+                listener.OnPopDispatcherContext();
+            }
         }
 
         internal void CloseGate()
@@ -281,6 +292,17 @@ private void ApplyDispatchingStrategies(EventBase evt, IEventCoordinator coordin
                 }
             }
         }
-
+        public TListener GetEventDispatchingListener<TListener>() where TListener : IEventDispatchingListener
+        {
+            foreach (var listener in dispatchingListeners)
+            {
+                if (listener is TListener tlistener) return tlistener;
+            }
+            return default;
+        }
+        public void AddEventDispatchingListener(IEventDispatchingListener listener)
+        {
+            dispatchingListeners.Add(listener);
+        }
     }
 }

Runtime/Core/Tasks/Models/TaskBase.cs

@@ -80,7 +80,6 @@ protected virtual void Init()
         {
             mStatus = TaskStatus.Stopped;
         }
-
         public virtual void Stop()
         {
             mStatus = TaskStatus.Stopped;
@@ -97,6 +96,10 @@ public virtual void Pause()
         public virtual void Tick()
         {
 
+        }
+        protected void CompleteTask()
+        {
+            mStatus = TaskStatus.Completed;
         }
         protected virtual void Reset()
         {