From aef1b8ac2898e147e6200fe257e8fdd82ee7fdbc Mon Sep 17 00:00:00 2001 From: wartech0 Date: Sun, 29 Dec 2019 08:06:02 -0600 Subject: Added the new ChestItemChanged event. --- src/SMAPI.sln | 4 +- src/SMAPI/Events/ChestItemChangedEventArgs.cs | 47 ++++++++++ src/SMAPI/Events/IWorldEvents.cs | 3 + src/SMAPI/Framework/Events/EventManager.cs | 4 + src/SMAPI/Framework/Events/ModWorldEvents.cs | 6 ++ src/SMAPI/Framework/SGame.cs | 4 + src/SMAPI/Framework/SnapshotListDiff.cs | 8 ++ .../StateTracking/FieldWatchers/NetListWatcher.cs | 100 +++++++++++++++++++++ .../Framework/StateTracking/LocationTracker.cs | 21 +++++ .../StateTracking/Snapshots/LocationSnapshot.cs | 5 ++ 10 files changed, 200 insertions(+), 2 deletions(-) create mode 100644 src/SMAPI/Events/ChestItemChangedEventArgs.cs create mode 100644 src/SMAPI/Framework/StateTracking/FieldWatchers/NetListWatcher.cs (limited to 'src') diff --git a/src/SMAPI.sln b/src/SMAPI.sln index 62eaa777..65ea330c 100644 --- a/src/SMAPI.sln +++ b/src/SMAPI.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio Version 16 -VisualStudioVersion = 16.0.28729.10 +# Visual Studio 15 +VisualStudioVersion = 15.0.28307.902 MinimumVisualStudioVersion = 10.0.40219.1 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".root", ".root", "{86C452BE-D2D8-45B4-B63F-E329EB06CEDA}" ProjectSection(SolutionItems) = preProject diff --git a/src/SMAPI/Events/ChestItemChangedEventArgs.cs b/src/SMAPI/Events/ChestItemChangedEventArgs.cs new file mode 100644 index 00000000..6b06487c --- /dev/null +++ b/src/SMAPI/Events/ChestItemChangedEventArgs.cs @@ -0,0 +1,47 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Microsoft.Xna.Framework; +using StardewValley; +using Item = StardewValley.Item; + +namespace StardewModdingAPI.Events +{ + /// Event arguments for a event. + public class ChestItemChangedEventArgs : EventArgs + { + /********* + ** Accessors + *********/ + /// The location which changed. + public GameLocation Location { get; } + + /// The objects added to the location. + public IEnumerable Added { get; } + + /// The objects removed from the location. + public IEnumerable Removed { get; } + + /// The location of the chest from where the item was added or removed + public Vector2 LocationOfChest { get; } + + /// Whether this is the location containing the local player. + public bool IsCurrentLocation => object.ReferenceEquals(this.Location, Game1.player?.currentLocation); + + + /********* + ** Public methods + *********/ + /// Construct an instance. + /// The location which changed. + /// The objects added to the location. + /// The objects removed from the location. + internal ChestItemChangedEventArgs(GameLocation location, IEnumerable added, IEnumerable removed, Vector2 locationOfChest) + { + this.Location = location; + this.Added = added.ToArray(); + this.Removed = removed.ToArray(); + this.LocationOfChest = locationOfChest; + } + } +} diff --git a/src/SMAPI/Events/IWorldEvents.cs b/src/SMAPI/Events/IWorldEvents.cs index 0ceffcc1..6f9b71a7 100644 --- a/src/SMAPI/Events/IWorldEvents.cs +++ b/src/SMAPI/Events/IWorldEvents.cs @@ -23,6 +23,9 @@ namespace StardewModdingAPI.Events /// Raised after objects are added or removed in a location. event EventHandler ObjectListChanged; + /// Raised after items are added or removed from a chest in a location. + event EventHandler ChestItemChanged; + /// Raised after terrain features (like floors and trees) are added or removed in a location. event EventHandler TerrainFeatureListChanged; } diff --git a/src/SMAPI/Framework/Events/EventManager.cs b/src/SMAPI/Framework/Events/EventManager.cs index 18b00f69..dad45f95 100644 --- a/src/SMAPI/Framework/Events/EventManager.cs +++ b/src/SMAPI/Framework/Events/EventManager.cs @@ -148,6 +148,9 @@ namespace StardewModdingAPI.Framework.Events /// Raised after objects are added or removed in a location. public readonly ManagedEvent ObjectListChanged; + /// Raised after a new item is added or removed from a chest in a location. + public readonly ManagedEvent ChestItemsChanged; + /// Raised after terrain features (like floors and trees) are added or removed in a location. public readonly ManagedEvent TerrainFeatureListChanged; @@ -221,6 +224,7 @@ namespace StardewModdingAPI.Framework.Events this.LocationListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.BuildingListChanged)); this.NpcListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.NpcListChanged)); this.ObjectListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.ObjectListChanged)); + this.ChestItemsChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.ChestItemChanged)); this.TerrainFeatureListChanged = ManageEventOf(nameof(IModEvents.World), nameof(IWorldEvents.TerrainFeatureListChanged)); this.LoadStageChanged = ManageEventOf(nameof(IModEvents.Specialized), nameof(ISpecializedEvents.LoadStageChanged)); diff --git a/src/SMAPI/Framework/Events/ModWorldEvents.cs b/src/SMAPI/Framework/Events/ModWorldEvents.cs index b85002a3..8d6701ec 100644 --- a/src/SMAPI/Framework/Events/ModWorldEvents.cs +++ b/src/SMAPI/Framework/Events/ModWorldEvents.cs @@ -51,6 +51,12 @@ namespace StardewModdingAPI.Framework.Events remove => this.EventManager.ObjectListChanged.Remove(value); } + public event EventHandler ChestItemChanged + { + add => this.EventManager.ChestItemsChanged.Add(value); + remove => this.EventManager.ChestItemsChanged.Remove(value); + } + /// Raised after terrain features (like floors and trees) are added or removed in a location. public event EventHandler TerrainFeatureListChanged { diff --git a/src/SMAPI/Framework/SGame.cs b/src/SMAPI/Framework/SGame.cs index 4774233e..564fec1d 100644 --- a/src/SMAPI/Framework/SGame.cs +++ b/src/SMAPI/Framework/SGame.cs @@ -702,6 +702,10 @@ namespace StardewModdingAPI.Framework if (locState.Objects.IsChanged) events.ObjectListChanged.Raise(new ObjectListChangedEventArgs(location, locState.Objects.Added, locState.Objects.Removed)); + // chest items changed + if (locState.ChestItems.IsChanged) + events.ChestItemsChanged.Raise(new ChestItemChangedEventArgs(location, locState.ChestItems.Added, locState.ChestItems.Removed, locState.ChestItems.Key)); + // terrain features changed if (locState.TerrainFeatures.IsChanged) events.TerrainFeatureListChanged.Raise(new TerrainFeatureListChangedEventArgs(location, locState.TerrainFeatures.Added, locState.TerrainFeatures.Removed)); diff --git a/src/SMAPI/Framework/SnapshotListDiff.cs b/src/SMAPI/Framework/SnapshotListDiff.cs index d4d5df50..b14cacdb 100644 --- a/src/SMAPI/Framework/SnapshotListDiff.cs +++ b/src/SMAPI/Framework/SnapshotListDiff.cs @@ -29,10 +29,18 @@ namespace StardewModdingAPI.Framework /// The added values. public IEnumerable Added => this.AddedImpl; + public Microsoft.Xna.Framework.Vector2 Key; /********* ** Public methods *********/ + + public void Update(ICollectionWatcher watcher, Microsoft.Xna.Framework.Vector2 key) + { + this.Key = key; + this.Update(watcher.IsChanged, watcher.Removed, watcher.Added); + } + /// Update the snapshot. /// Whether the value changed since the last update. /// The removed values. diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/NetListWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetListWatcher.cs new file mode 100644 index 00000000..cac66356 --- /dev/null +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetListWatcher.cs @@ -0,0 +1,100 @@ +using System; +using System.Collections.Generic; +using Netcode; + +namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers +{ + internal class NetListWatcher : BaseDisposableWatcher, ICollectionWatcher + where TValue : class, INetObject + { + + + /********* + ** Fields + *********/ + /// The field being watched. + private readonly NetList> Field; + + public TKey Key { get; } + + /// The pairs added since the last reset. + private readonly IList AddedImpl = new List(); + + /// The pairs removed since the last reset. + private readonly IList RemovedImpl = new List(); + + /********* + ** Public methods + *********/ + /// Construct an instance. + /// The field to watch. + public NetListWatcher(NetList> field, TKey key) + { + this.Field = field; + this.Key = key; + field.OnElementChanged += this.OnElementChanged; + field.OnArrayReplaced += this.OnArrayReplaced; + } + + public bool IsChanged => this.AddedImpl.Count > 0 || this.RemovedImpl.Count > 0; + + public IEnumerable Added => this.AddedImpl; + + public IEnumerable Removed => this.RemovedImpl; + + public void Dispose() + { + if (!this.IsDisposed) + { + this.Field.OnElementChanged -= this.OnElementChanged; + this.Field.OnArrayReplaced -= this.OnArrayReplaced; + } + + base.Dispose(); + } + + public void Reset() + { + this.AddedImpl.Clear(); + this.RemovedImpl.Clear(); + } + + public void Update() + { + this.AssertNotDisposed(); + } + + /********* + ** Private methods + *********/ + private void OnArrayReplaced(NetList> list, IList before, IList after) + { + this.AddedImpl.Clear(); + this.RemovedImpl.Clear(); + + foreach(var obj in after) + this.AddedImpl.Add(obj); + + foreach(var obj in before) + this.RemovedImpl.Add(obj); + } + + private void OnElementChanged(NetList> list, int index, TValue oldValue, TValue newValue) + { + + /* checks for stack addition / subtraction changing stacks does not fire off an element changed event + if ((oldValue != null && newValue != null) && oldValue.CompareTo(newValue) < 0) + this.AddedImpl.Add(newValue); + //Stack Removed from + if ((oldValue != null && newValue != null) && oldValue.CompareTo(newValue) > 0) + this.RemovedImpl.Add(newValue); + */ + + if(newValue!=null) + this.AddedImpl.Add(newValue); + + if(oldValue!=null) + this.RemovedImpl.Add(oldValue); + } + } +} diff --git a/src/SMAPI/Framework/StateTracking/LocationTracker.cs b/src/SMAPI/Framework/StateTracking/LocationTracker.cs index 1f479e12..ef4a8b64 100644 --- a/src/SMAPI/Framework/StateTracking/LocationTracker.cs +++ b/src/SMAPI/Framework/StateTracking/LocationTracker.cs @@ -7,6 +7,7 @@ using StardewValley.Buildings; using StardewValley.Locations; using StardewValley.TerrainFeatures; using Object = StardewValley.Object; +using Chest = StardewValley.Objects.Chest; namespace StardewModdingAPI.Framework.StateTracking { @@ -47,6 +48,7 @@ namespace StardewModdingAPI.Framework.StateTracking /// Tracks added or removed terrain features. public IDictionaryWatcher TerrainFeaturesWatcher { get; } + public Dictionary> activeChestWatchers = new Dictionary>(); /********* ** Public methods @@ -88,6 +90,25 @@ namespace StardewModdingAPI.Framework.StateTracking { foreach (IWatcher watcher in this.Watchers) watcher.Update(); + + foreach (KeyValuePair obj in this.ObjectsWatcher.Added.Where(p => p.Value is Chest)) + { + if (!this.activeChestWatchers.ContainsKey(obj.Key)) + { + //create a new watcher for chests items + Chest temp = obj.Value as Chest; + NetListWatcher tempItemWatcher = new NetListWatcher(temp.items, obj.Key); + this.Watchers.Add(tempItemWatcher); + this.activeChestWatchers.Add(obj.Key, tempItemWatcher); + } + } + + foreach (KeyValuePair obj in this.ObjectsWatcher.Removed) + { + this.activeChestWatchers.TryGetValue(obj.Key, out NetListWatcher tempItemWatcher); + this.Watchers.Remove(tempItemWatcher); + this.activeChestWatchers.Remove(obj.Key); + } } /// Set the current value as the baseline. diff --git a/src/SMAPI/Framework/StateTracking/Snapshots/LocationSnapshot.cs b/src/SMAPI/Framework/StateTracking/Snapshots/LocationSnapshot.cs index d3029540..31cf29c3 100644 --- a/src/SMAPI/Framework/StateTracking/Snapshots/LocationSnapshot.cs +++ b/src/SMAPI/Framework/StateTracking/Snapshots/LocationSnapshot.cs @@ -33,6 +33,8 @@ namespace StardewModdingAPI.Framework.StateTracking.Snapshots /// Tracks added or removed terrain features. public SnapshotListDiff> TerrainFeatures { get; } = new SnapshotListDiff>(); + public SnapshotListDiff ChestItems { get; } = new SnapshotListDiff(); + /********* ** Public methods @@ -54,6 +56,9 @@ namespace StardewModdingAPI.Framework.StateTracking.Snapshots this.Npcs.Update(watcher.NpcsWatcher); this.Objects.Update(watcher.ObjectsWatcher); this.TerrainFeatures.Update(watcher.TerrainFeaturesWatcher); + + foreach (var obj in watcher.activeChestWatchers) + this.ChestItems.Update(obj.Value, obj.Key); } } } -- cgit