summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/StateTracking/FieldWatchers/NetValueWatcher.cs
blob: 188ed9f3f7ca618c4244812151b8933ea1354b9b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
using Netcode;

namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers
{
    /// <summary>A watcher which detects changes to a net value field.</summary>
    internal class NetValueWatcher<T, TSelf> : BaseDisposableWatcher, IValueWatcher<T> where TSelf : NetFieldBase<T, TSelf>
    {
        /*********
        ** Properties
        *********/
        /// <summary>The field being watched.</summary>
        private readonly NetFieldBase<T, TSelf> Field;


        /*********
        ** Accessors
        *********/
        /// <summary>Whether the value changed since the last reset.</summary>
        public bool IsChanged { get; private set; }

        /// <summary>The field value at the last reset.</summary>
        public T PreviousValue { get; private set; }

        /// <summary>The latest value.</summary>
        public T CurrentValue { get; private set; }


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="field">The field to watch.</param>
        public NetValueWatcher(NetFieldBase<T, TSelf> field)
        {
            this.Field = field;
            this.PreviousValue = field.Value;
            this.CurrentValue = field.Value;

            field.fieldChangeVisibleEvent += this.OnValueChanged;
            field.fieldChangeEvent += this.OnValueChanged;
        }

        /// <summary>Update the current value if needed.</summary>
        public void Update()
        {
            this.AssertNotDisposed();
        }

        /// <summary>Set the current value as the baseline.</summary>
        public void Reset()
        {
            this.AssertNotDisposed();

            this.PreviousValue = this.CurrentValue;
            this.IsChanged = false;
        }

        /// <summary>Stop watching the field and release all references.</summary>
        public override void Dispose()
        {
            if (!this.IsDisposed)
            {
                this.Field.fieldChangeEvent -= this.OnValueChanged;
                this.Field.fieldChangeVisibleEvent -= this.OnValueChanged;
            }
            base.Dispose();
        }


        /*********
        ** Private methods
        *********/
        /// <summary>A callback invoked when the field's value changes.</summary>
        /// <param name="field">The field being watched.</param>
        /// <param name="oldValue">The old field value.</param>
        /// <param name="newValue">The new field value.</param>
        private void OnValueChanged(TSelf field, T oldValue, T newValue)
        {
            this.CurrentValue = newValue;
            this.IsChanged = true;
        }
    }
}