Merge pull request #2 from sator-imaging/active/v0.9

Active/v0.9

Author: sator-imaging

LifecycleBehaviour.cs

@@ -1,14 +1,14 @@
-/** Simple Lifecycle Manager for Unity
+/** CancellationToken based Lifecycle Manager for Unity
  ** (c) 2024 github.com/sator-imaging
  ** Licensed under the MIT License
 
-This library helps managing MonoBehaviour lifetime by CancellationToken introduced in Unity 2022.
+This library helps managing MonoBehaviour lifetime by `CancellationToken` introduced in Unity 2022.
 Not only that but also has an ability to manage "Update" actions ordered and efficiently.
 
 And also! library provides missing `destroyCancellationToken` feature for Unity 2021 LTS!!
 
 **Feature Highlights**
-- [Class Instance Lifetime Management](#object-lifetime-management)
+- [Object Lifetime Management](#object-lifetime-management)
 - [Update Function Manager](#update-function-manager)
     - Designed to address consideration written in the following article
     - https://blog.unity.com/engine-platform/10000-update-calls
@@ -101,7 +101,7 @@ Note that C# class instances and GameObjects destruction order is stable whereas
 when scene is unloaded otherwise destroyed based on binding order.
 
 > [!NOTE]
-> To make destruction order stable, extension method automatically mark lifetime bound GameObjects as
+> To make destruction order stable, extension method automatically marks lifetime bound GameObjects as
 > `DontDestroyOnLoad`.
 
 
@@ -512,12 +512,12 @@ public void Clear()
             /// Do nothing when null action specified.
             /// </remarks>
             /// <returns>
-            /// Returns received action instance as-is. It is null when null is passed.
             /// <para>
+            /// Returns received action instance as-is. It is null when null is passed.
+            /// </para>
             /// > [!NOTE]
             /// > `Add(instance.Method)` will create new Action instance call by call implicitly.
-            /// > If try to remove action later, it requires to specify exactly same instance so need to keep returned instance.
-            /// </para>
+            /// > If plan to remove action later, removing requires exactly same instance so need to keep returned one.
             /// </returns>
             public Action Add(Action act)
             {
@@ -540,11 +540,11 @@ public Action Add(Action act)
             }
 
             /// <remarks>
-            /// Do nothing when null action specified.
             /// <para>
+            /// Do nothing when null action specified.
+            /// </para>
             /// > [!WARNING]
             /// > Item order will be changed. See file header document for details.
-            /// </para>
             /// </remarks>
             public void Remove(Action act)
             {
@@ -611,12 +611,12 @@ internal SceneLifetime(Scene scene)
         {
             if (_sceneToLifetime.ContainsKey(scene))
             {
-                throw new InvalidOperationException(
+                throw new ArgumentException(
                     LOG_PREFIX + "scene lifetime has already been created. use `Get` method instead: " + scene);
             }
 
             if (!scene.IsValid())
-                throw new NotSupportedException(LOG_PREFIX + "scene is invalid: " + scene);
+                throw new ArgumentException(LOG_PREFIX + "scene is invalid: " + scene);
 
             _sceneInfo = "BuildIndex:" + scene.buildIndex + " " + scene.name;
             _sceneToLifetime.Add(scene, this);
@@ -745,7 +745,7 @@ public static class LifetimeExtensions
         /// <summary>
         /// Arguments: (obj, token, ticket, ownerOrNull)
         /// <para>
-        /// Invoked before object bound to token.
+        /// Invoked when object bound to token or lifetime owner.
         /// </para>
         /// </summary>
         public static Action<object, CancellationToken, CancellationTokenRegistration, object?>? DebuggerAction

README.md

@@ -1,10 +1,12 @@
-This library helps managing MonoBehaviour lifetime by CancellationToken introduced in Unity 2022.
+# CancellationToken based Lifecycle Manager for Unity
+
+This library helps managing MonoBehaviour lifetime by `CancellationToken` introduced in Unity 2022.
 Not only that but also has an ability to manage "Update" actions ordered and efficiently.
 
 And also! library provides missing `destroyCancellationToken` feature for Unity 2021 LTS!!
 
 **Feature Highlights**
-- [Class Instance Lifetime Management](#object-lifetime-management)
+- [Object Lifetime Management](#object-lifetime-management)
 - [Update Function Manager](#update-function-manager)
     - Designed to address consideration written in the following article
     - https://blog.unity.com/engine-platform/10000-update-calls
@@ -97,7 +99,7 @@ destruction order is NOT stable. For reference, MonoBehaviours (components) will
 when scene is unloaded otherwise destroyed based on binding order.
 
 > [!NOTE]
-> To make destruction order stable, extension method automatically mark lifetime bound GameObjects as
+> To make destruction order stable, extension method automatically marks lifetime bound GameObjects as
 > `DontDestroyOnLoad`.
 
 

package.json

@@ -1,9 +1,9 @@
 {
   "name": "com.sator-imaging.unity-lifecycle-manager",
-  "displayName": "MonoBehaviour Lifecycle Manager",
+  "displayName": "CancellationToken based Lifecycle Manager",
   "version": "0.9.0",
   "unity": "2021.3",
-  "description": "MonoBehaviour lifecycle and update function manager.",
+  "description": "Provides MonoBehaviour update function manager component and CancellationToken based object lifetime management.",
   "author": {
     "name": "Sator Imaging",
     "url": "https://twitter.com/sator_imaging"