Optimzed milestones. Updated README and added some additional tests.

Author: PaulNonatomic

CHANGELOG.md

@@ -1,4 +1,9 @@
 # Change Log
 
+## [0.1.0-beta] - Feb 26, 2025
+- Optimized Milstones
+- Added additional test for Milestone removal
+- Adjust namespace to be more consistent with other Nonatomic packages
+
 ## [0.0.0-beta] - Sept 28, 2024
 - First commit

README.md

@@ -1,40 +1,43 @@
-# Timers #
+# Timers
 
-## Overview ##
-Timer is a versatile, easy-to-use timer component designed for Unity projects. It supports basic timing operations like start, stop, and reset, along with advanced features such as pausing, resuming, fast forwarding, rewinding, and handling milestones that trigger custom actions.
+## Overview
+**Timers** is a versatile, easy-to-use timer component designed for Unity projects. Whether you’re building a countdown for a game level, managing cooldowns, or triggering events at specific intervals, this package provides a robust solution. It combines basic timing functionality with advanced features, all wrapped in an extensible and Unity-friendly design.
 
 ### Features
-- Basic Timer Operations: Start, stop, and reset the timer.
-- Pause and Resume: Pause the timer and resume from the last stopped point without resetting.
-- Fast Forward and Rewind: Jump forward or backward in time.
-- **Milestones:** Set up callbacks to execute when the timer reaches certain points.
-- **Serialization:** Serialize and deserialize the timer's state, useful for game saves.
-- **Extensible:** Easy to extend with additional features and integrate into larger systems.
-
-## Installation ##
-To install the Timers package in your Unity project, follow these steps:
-
-1. Open Unity and navigate to the Package Manager.
-   - Click on the + button and select Add package from git URL...
-   - Enter the following URL: https://github.com/PaulNonatomic/Timer and press Add.
-2. Add the Timer component onto any active GameObject in your scene, or create a new GameObject dedicated to the timer.
-
-## Usage ## 
-
-## API Reference ##
-* StartTimer(): Start or restart the timer.
-* StopTimer(): Pause the timer.
-* ResetTimer(): Reset the timer to its initial state.
-* ResumeTimer(): Resume the timer from the last paused state.
-* FastForward(float seconds): Advance the timer by a specified number of seconds.
-* Rewind(float seconds): Reverse the timer by a specified number of seconds.
-* AddMilestone(TimerMilestone milestone): Add a milestone that triggers a callback when reached.
-* RemoveMilestone(TimerMilestone milestone): Remove a milestone from the timer.
-* ClearMilestones(): Clears all milestones from the timer, ceasing any pending triggers.
-* RemoveMilestonesByCondition(Predicate<TimerMilestone> condition): Removes a specific milestone from the timer.
-
-## Contributing ##
-Contributions are welcome! Please refer to CONTRIBUTING.md for guidelines on how to contribute.
-
-## License ##
-The Timers package is licensed under the MIT license. See LICENSE for more details.
+- **Basic Operations**: Start, stop, reset, and query the timer’s state.
+- **Pause & Resume**: Pause the timer and pick up where you left off.
+- **Fast Forward & Rewind**: Skip ahead or backtrack through time.
+- **Milestones**: Trigger custom actions at specific time or progress points.
+- **Serialization**: Save and load timer states for persistent gameplay.
+- **Unity Integration**: Works seamlessly as a MonoBehaviour or standalone class.
+- **Extensible**: Virtual methods and interfaces make customization a breeze.
+
+## Installation
+Add the Timers package to your Unity project via the Unity Package Manager:
+
+1. Open the Package Manager (`Window > Package Manager`).
+2. Click the **+** button and select **"Add package from git URL"**.
+3. Enter: `https://github.com/PaulNonatomic/Timer.git`.
+4. Click **Add**.
+
+## Usage
+Below are some practical examples to get you started with Timers in your Unity project.
+
+### Example 1: Simple Countdown
+Create a 30-second countdown that logs when it’s done.
+```csharp
+using Timers.Runtime;
+using UnityEngine;
+
+public class CountdownExample : MonoBehaviour
+{
+    private Timer _timer;
+
+    void Start()
+    {
+        _timer = gameObject.AddComponent<Timer>();
+        _timer.Duration = 30f; // 30 seconds
+        _timer.OnComplete += () => Debug.Log("Countdown finished!");
+        _timer.StartTimer();
+    }
+}

Runtime/IReadOnlyTimer.cs

@@ -1,4 +1,4 @@
-namespace Timers.Runtime
+namespace Nonatomic.Timers
 {
 	public interface IReadOnlyTimer
 	{

Runtime/ITimer.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace Timers.Runtime
+namespace Nonatomic.Timers
 {
 	/// <summary>
 	/// Defines a contract for timer functionality, allowing for starting, stopping, and resetting the timer,

Runtime/SimpleTimer.cs

@@ -1,9 +1,8 @@
 using System;
 using System.Collections.Generic;
 using UnityEngine;
-using UnityEngine.UIElements;
 
-namespace Timers.Runtime
+namespace Nonatomic.Timers
 {
 	/// <summary>
 	/// Implements a basic countdown timer with start, stop, reset, fast forward, and rewind capabilities,
@@ -39,7 +38,7 @@ public float Duration
 
 		private float _duration;
 		private bool _isRunning;
-		private List<TimerMilestone> _milestones = new List<TimerMilestone>();
+		private SortedList<float, TimerMilestone> _milestones = new SortedList<float, TimerMilestone>();
 
 		/// <summary>
 		/// Initializes a new instance of the SimpleTimer class with a specified duration.
@@ -107,22 +106,24 @@ public virtual void Update(float deltaTime)
 
 		protected virtual void CheckAndTriggerMilestones()
 		{
-			_milestones.RemoveAll(milestone =>
+			while (_milestones.Count > 0 && ShouldTrigger(_milestones.Values[0]))
 			{
-				var shouldTrigger = milestone.Type switch
-				{
-					TimeType.TimeRemaining => TimeRemaining <= milestone.TriggerValue,
-					TimeType.TimeElapsed => TimeElapsed >= milestone.TriggerValue,
-					TimeType.ProgressElapsed => ProgressElapsed >= milestone.TriggerValue,
-					TimeType.ProgressRemaining => ProgressRemaining <= milestone.TriggerValue,
-					_ => throw new ArgumentOutOfRangeException()
-				};
-
-				if (!shouldTrigger) return false;
-				
+				var milestone = _milestones.Values[0];
 				milestone.Callback?.Invoke();
-				return true;  // Mark for removal
-			});
+				_milestones.RemoveAt(0);
+			}
+		}
+
+		private bool ShouldTrigger(TimerMilestone milestone)
+		{
+			return milestone.Type switch
+			{
+				TimeType.TimeRemaining => TimeRemaining <= milestone.TriggerValue,
+				TimeType.TimeElapsed => TimeElapsed >= milestone.TriggerValue,
+				TimeType.ProgressElapsed => ProgressElapsed >= milestone.TriggerValue,
+				TimeType.ProgressRemaining => ProgressRemaining <= milestone.TriggerValue,
+				_ => throw new ArgumentOutOfRangeException(nameof(milestone.Type), "Unknown TimeType")
+			};
 		}
 
 		/// <summary>
@@ -183,12 +184,12 @@ public virtual void Rewind(float seconds)
 		/// <param name="milestone">The milestone to add to the timer.</param>
 		public virtual void AddMilestone(TimerMilestone milestone)
 		{
-			_milestones.Add(milestone);
+			_milestones.Add(milestone.TriggerValue, milestone);
 		}
 
 		public virtual void RemoveMilestone(TimerMilestone milestone)
 		{
-			_milestones.Remove(milestone);
+			_milestones.Remove(milestone.TriggerValue);
 		}
 
 		public virtual void ClearMilestones()
@@ -198,7 +199,21 @@ public virtual void ClearMilestones()
 
 		public virtual void RemoveMilestonesByCondition(Predicate<TimerMilestone> condition)
 		{
-			_milestones.RemoveAll(condition);
+			// Collect keys to remove to avoid modifying the collection during iteration
+			var keysToRemove = new List<float>();
+			foreach (var pair in _milestones)
+			{
+				if (condition(pair.Value))
+				{
+					keysToRemove.Add(pair.Key);
+				}
+			}
+	
+			// Remove all identified keys
+			foreach (var key in keysToRemove)
+			{
+				_milestones.Remove(key);
+			}
 		}
 
 		/// <summary>

Runtime/TimeType.cs

@@ -1,4 +1,4 @@
-namespace Timers.Runtime
+namespace Nonatomic.Timers
 {
 	public enum TimeType
 	{

Runtime/Timer.cs

@@ -1,7 +1,7 @@
 using System;
 using UnityEngine;
 
-namespace Timers.Runtime
+namespace Nonatomic.Timers
 {
 	/// <summary>
 	/// A Unity MonoBehaviour that manages a timer, allowing it to be used within the Unity Engine's update system.

Runtime/TimerMilestone.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace Timers.Runtime
+namespace Nonatomic.Timers
 {
 	public class TimerMilestone
 	{
@@ -15,5 +15,4 @@ public TimerMilestone(TimeType type, float triggerValue, Action callback)
 			Callback = callback;
 		}
 	}
-
 }

Runtime/TimerUtility.cs

@@ -1,4 +1,4 @@
-namespace Timers.Runtime
+namespace Nonatomic.Timers
 {
 	using System;
 	using static System.TimeSpan;

Tests/EditMode/SimpleTimerTests.cs

@@ -1,6 +1,5 @@
 using NUnit.Framework;
-using Timers.Runtime;
-using UnityEngine;
+using Nonatomic.Timers;
 
 namespace Tests.EditMode
 {
@@ -124,6 +123,22 @@ public void Rewind_And_FastForward_AreAccurate()
 			Assert.AreEqual(4, _simpleTimer.TimeRemaining, "Operations should accurately modify TimeRemaining.");
 		}
 
+		[Test]
+		public void RemoveMilestonesByCondition_Removes_Correctly()
+		{
+			var triggered1 = false;
+			var triggered2 = false;
+			var milestone1 = new TimerMilestone(TimeType.TimeRemaining, 5, () => triggered1 = true);
+			var milestone2 = new TimerMilestone(TimeType.TimeRemaining, 3, () => triggered2 = true);
+			_simpleTimer.AddMilestone(milestone1);
+			_simpleTimer.AddMilestone(milestone2);
+			_simpleTimer.RemoveMilestonesByCondition(m => m.TriggerValue == 5);
+			_simpleTimer.StartTimer();
+			_simpleTimer.Update(7); // Triggers 3, not 5
+			Assert.IsFalse(triggered1, "Removed milestone should not trigger.");
+			Assert.IsTrue(triggered2, "Remaining milestone should trigger.");
+		}
+		
 		[Test]
 		public void Milestone_Should_Trigger_When_Time_Remaining_Reaches_Specified_Value()
 		{