feat: 💥 update to attach timer method and add more docs

ChronityTest/Assets/Scripts/Runtime/ChronityTest.cs

@@ -7,7 +7,7 @@ public class ChronityTest : MonoBehaviour
 
     public void StartTimer()
     {
-        timer = this.RegisterTimer(5, () => Debug.Log("Hello World"), x => Debug.Log($"Timer Updated: {x}"));
+        timer = this.AttachTimer(5, () => Debug.Log("Hello World"), x => Debug.Log($"Timer Updated: {x}"));
     }
 
     public void PauseTimer()

ChronityTest/Packages/packages-lock.json

@@ -5,7 +5,7 @@
       "depth": 0,
       "source": "git",
       "dependencies": {},
-      "hash": "10dc5e1220227bc4e3640d732612bab751b98190"
+      "hash": "b4a335d2d374e9d2daae6b6ae7b901148f3f24a9"
     },
     "com.unity.2d.animation": {
       "version": "5.0.10",

README.md

@@ -1,4 +1,4 @@
-# Chronity
+[![# Chronity](./.github/images/Slide.png)](https://sushiwaumai.github.io/Chronity)
 
 [![Release](https://img.shields.io/github/v/release/SushiWaUmai/Chronity?include_prereleases&style=flat-square)](https://github.com/SushiWaUmai/Chronity/releases)
 [![OpenUPM](https://img.shields.io/npm/v/com.sushiwaumai.chronity?label=openupm&registry_uri=https://package.openupm.com&style=flat-square)](https://openupm.com/packages/com.sushiwaumai.chronity/)
@@ -10,6 +10,8 @@
 
 This package is a fork of the [UnityTimer](https://github.com/akbiggs/UnityTimer) made by [akbiggs](https://github.com/akbiggs).
 
+To get started, read the [docs](https://sushiwaumai.github.io/Chronity) or follow this [README](README.md) file.
+
 ## Table of Contents
 - [Getting Started](https://github.com/SushiWaUmai/Chronity#getting-started-rocket)
   - [Installation](https://github.com/SushiWaUmai/Chronity#installation)
@@ -75,7 +77,7 @@ public class CoolMonoBehaviour : MonoBehaviour
     {
         // Use the AttachTimer extension method to create a timer that is destroyed when this
         // object is destroyed.
-        this.RegisterTimer(5f, () => {
+        this.AttachTimer(5f, () => {
 
             // If this code runs after the object is destroyed, a null reference will be thrown,
             // which could corrupt game state.
@@ -106,6 +108,16 @@ Timer.Register(transitionDuration,
    onComplete: () => Debug.Log("Color is now red"));
 ```
 
+**Make a timer presist through scene changes using the `cancelOnSceneChange` parameter.**
+```c#
+// Make a timer that will persist through scene changes.
+Timer.Register(5f, () => Debug.Log("Hello World"), cancelOnSceneChange: false);
+
+// Change scene from another script 
+
+// Logs "Hello World" after 5 seconds.
+```
+
 **Make a timer run in the editor by using the `EditorTimer` class.**
 ```c#
 // Logs "Hello World" after 5 seconds in the editor

com.sushiwaumai.chronity/Runtime/TimerExtension.cs

@@ -22,7 +22,7 @@ public static class TimerExtension
         /// <param name="isLooped">Whether the timer should restart after executing.</param>
         /// <param name="cancelOnSceneChange">Whether the timer should cancel when the scene changes</param>
         /// <returns>A timer object that allows you to examine stats and stop/resume progress.</returns>
-        public static Timer RegisterTimer(this MonoBehaviour behaviour, float duration, Action onComplete, Action<float> onUpdate = null, bool useRealTime = false, bool isLooped = false, bool cancelOnSceneChange = true)
+        public static Timer AttachTimer(this MonoBehaviour behaviour, float duration, Action onComplete, Action<float> onUpdate = null, bool useRealTime = false, bool isLooped = false, bool cancelOnSceneChange = true)
         {
             Timer result = Timer.Register(duration, onComplete, onUpdate, useRealTime, isLooped, cancelOnSceneChange, behaviour);
             return result;

com.sushiwaumai.chronity/package.json

@@ -1,9 +1,8 @@
 {
   "name": "com.sushiwaumai.chronity",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "displayName": "Chronity",
   "description": "Library for running functions after a delay by creating timers in Unity3D.",
   "unity": "2020.3",
-  "type": "library",
-  "dependencies": {}
+  "type": "library"
 }

docfx_project/manual/features.md

@@ -41,7 +41,7 @@ public class CoolMonoBehaviour : MonoBehaviour
     {
         // Use the AttachTimer extension method to create a timer that is destroyed when this
         // object is destroyed.
-        this.RegisterTimer(5f, () => {
+        this.AttachTimer(5f, () => {
 
             // If this code runs after the object is destroyed, a null reference will be thrown,
             // which could corrupt game state.
@@ -72,6 +72,16 @@ Timer.Register(transitionDuration,
    onComplete: () => Debug.Log("Color is now red"));
 ```
 
+**Make a timer presist through scene changes using the `cancelOnSceneChange` parameter.**
+```c#
+// Make a timer that will persist through scene changes.
+Timer.Register(5f, () => Debug.Log("Hello World"), cancelOnSceneChange: false);
+
+// Change scene from another script 
+
+// Logs "Hello World" after 5 seconds.
+```
+
 **Make a timer run in the editor by using the `EditorTimer` class.**
 ```c#
 // Logs "Hello World" after 5 seconds in the editor