Merge branch 'develop' into stable

1 files changed, 44 insertions, 0 deletions

diff --git a/src/SMAPI/Framework/Utilities/Countdown.cs b/src/SMAPI/Framework/Utilities/Countdown.cs
new file mode 100644
index 00000000..921a35ce
--- /dev/null
+++ b/src/SMAPI/Framework/Utilities/Countdown.cs
@@ -0,0 +1,44 @@
+namespace StardewModdingAPI.Framework.Utilities
+{
+    /// <summary>Counts down from a baseline value.</summary>
+    internal class Countdown
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The initial value from which to count down.</summary>
+        public int Initial { get; }
+
+        /// <summary>The current value.</summary>
+        public int Current { get; private set; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="initial">The initial value from which to count down.</param>
+        public Countdown(int initial)
+        {
+            this.Initial = initial;
+            this.Current = initial;
+        }
+
+        /// <summary>Reduce the current value by one.</summary>
+        /// <returns>Returns whether the value was decremented (i.e. wasn't already zero).</returns>
+        public bool Decrement()
+        {
+            if (this.Current <= 0)
+                return false;
+
+            this.Current--;
+            return true;
+        }
+        
+        /// <summary>Restart the countdown.</summary>
+        public void Reset()
+        {
+            this.Current = this.Initial;
+        }
+    }
+}