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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Xna.Framework;
using StardewModdingAPI.Events;
using StardewModdingAPI.Framework.StateTracking.FieldWatchers;
using StardewValley;
using StardewValley.Locations;
using SFarmer = StardewValley.Farmer;
using SObject = StardewValley.Object;
namespace StardewModdingAPI.Framework.StateTracking
{
/// <summary>Tracks changes to a player's data.</summary>
internal class PlayerTracker : IDisposable
{
/*********
** Properties
*********/
/// <summary>The player's inventory as of the last reset.</summary>
private IDictionary<Item, int> PreviousInventory;
/// <summary>The player's inventory change as of the last update.</summary>
private IDictionary<Item, int> CurrentInventory;
/// <summary>The player's last valid location.</summary>
private GameLocation LastValidLocation;
/// <summary>The underlying watchers.</summary>
private readonly List<IWatcher> Watchers = new List<IWatcher>();
/*********
** Accessors
*********/
/// <summary>The player being tracked.</summary>
public SFarmer Player { get; }
/// <summary>The player's current location.</summary>
public IValueWatcher<GameLocation> LocationWatcher { get; }
/// <summary>Tracks changes to the player's current location's objects.</summary>
public IDictionaryWatcher<Vector2, SObject> LocationObjectsWatcher { get; private set; }
/// <summary>The player's current mine level.</summary>
public IValueWatcher<int> MineLevelWatcher { get; }
/// <summary>Tracks changes to the player's skill levels.</summary>
public IDictionary<EventArgsLevelUp.LevelType, IValueWatcher<int>> SkillWatchers { get; }
/*********
** Public methods
*********/
/// <summary>Construct an instance.</summary>
/// <param name="player">The player to track.</param>
public PlayerTracker(SFarmer player)
{
// init player data
this.Player = player;
this.PreviousInventory = this.GetInventory();
// init trackers
this.LocationWatcher = WatcherFactory.ForReference(this.GetCurrentLocation);
this.LocationObjectsWatcher = WatcherFactory.ForNetDictionary(this.GetCurrentLocation().objects);
this.MineLevelWatcher = WatcherFactory.ForEquatable(() => this.LastValidLocation is MineShaft mine ? mine.mineLevel : 0);
this.SkillWatchers = new Dictionary<EventArgsLevelUp.LevelType, IValueWatcher<int>>
{
[EventArgsLevelUp.LevelType.Combat] = WatcherFactory.ForEquatable(() => player.combatLevel),
[EventArgsLevelUp.LevelType.Farming] = WatcherFactory.ForEquatable(() => player.farmingLevel),
[EventArgsLevelUp.LevelType.Fishing] = WatcherFactory.ForEquatable(() => player.fishingLevel),
[EventArgsLevelUp.LevelType.Foraging] = WatcherFactory.ForEquatable(() => player.foragingLevel),
[EventArgsLevelUp.LevelType.Luck] = WatcherFactory.ForEquatable(() => player.luckLevel),
[EventArgsLevelUp.LevelType.Mining] = WatcherFactory.ForEquatable(() => player.miningLevel)
};
// track watchers for convenience
this.Watchers.AddRange(new IWatcher[]
{
this.LocationWatcher,
this.LocationObjectsWatcher,
this.MineLevelWatcher
});
this.Watchers.AddRange(this.SkillWatchers.Values);
}
/// <summary>Update the current values if needed.</summary>
public void Update()
{
// update valid location
this.LastValidLocation = this.GetCurrentLocation();
// update watchers
foreach (IWatcher watcher in this.Watchers)
watcher.Update();
// replace location objects watcher
if (this.LocationWatcher.IsChanged)
{
this.Watchers.Remove(this.LocationObjectsWatcher);
this.LocationObjectsWatcher.Dispose();
this.LocationObjectsWatcher = WatcherFactory.ForNetDictionary(this.GetCurrentLocation().objects);
this.Watchers.Add(this.LocationObjectsWatcher);
}
// update inventory
this.CurrentInventory = this.GetInventory();
}
/// <summary>Reset all trackers so their current values are the baseline.</summary>
public void Reset()
{
foreach (IWatcher watcher in this.Watchers)
watcher.Reset();
this.PreviousInventory = this.CurrentInventory;
}
/// <summary>Get the player's current location, ignoring temporary null values.</summary>
/// <remarks>The game will set <see cref="Character.currentLocation"/> to null in some cases, e.g. when they're a secondary player in multiplayer and transition to a location that hasn't been synced yet. While that's happening, this returns the player's last valid location instead.</remarks>
public GameLocation GetCurrentLocation()
{
return this.Player.currentLocation ?? this.LastValidLocation;
}
/// <summary>Get the player inventory changes between two states.</summary>
public IEnumerable<ItemStackChange> GetInventoryChanges()
{
IDictionary<Item, int> previous = this.PreviousInventory;
IDictionary<Item, int> current = this.GetInventory();
foreach (Item item in previous.Keys.Union(current.Keys))
{
if (!previous.TryGetValue(item, out int prevStack))
yield return new ItemStackChange { Item = item, StackChange = item.Stack, ChangeType = ChangeType.Added };
else if (!current.TryGetValue(item, out int newStack))
yield return new ItemStackChange { Item = item, StackChange = -item.Stack, ChangeType = ChangeType.Removed };
else if (prevStack != newStack)
yield return new ItemStackChange { Item = item, StackChange = newStack - prevStack, ChangeType = ChangeType.StackChange };
}
}
/// <summary>Get the player skill levels which changed.</summary>
public IEnumerable<KeyValuePair<EventArgsLevelUp.LevelType, IValueWatcher<int>>> GetChangedSkills()
{
return this.SkillWatchers.Where(p => p.Value.IsChanged);
}
/// <summary>Get the player's new location if it changed.</summary>
/// <param name="location">The player's current location.</param>
/// <returns>Returns whether it changed.</returns>
public bool TryGetNewLocation(out GameLocation location)
{
location = this.LocationWatcher.CurrentValue;
return this.LocationWatcher.IsChanged;
}
/// <summary>Get object changes to the player's current location if they there as of the last reset.</summary>
/// <param name="watcher">The object change watcher.</param>
/// <returns>Returns whether it changed.</returns>
public bool TryGetLocationChanges(out IDictionaryWatcher<Vector2, SObject> watcher)
{
if (this.LocationWatcher.IsChanged)
{
watcher = null;
return false;
}
watcher = this.LocationObjectsWatcher;
return watcher.IsChanged;
}
/// <summary>Get the player's new mine level if it changed.</summary>
/// <param name="mineLevel">The player's current mine level.</param>
/// <returns>Returns whether it changed.</returns>
public bool TryGetNewMineLevel(out int mineLevel)
{
mineLevel = this.MineLevelWatcher.CurrentValue;
return this.MineLevelWatcher.IsChanged;
}
/// <summary>Stop watching the player fields and release all references.</summary>
public void Dispose()
{
foreach (IWatcher watcher in this.Watchers)
watcher.Dispose();
}
/*********
** Private methods
*********/
/// <summary>Get the player's current inventory.</summary>
private IDictionary<Item, int> GetInventory()
{
return this.Player.Items
.Where(n => n != null)
.Distinct()
.ToDictionary(n => n, n => n.Stack);
}
}
}
|
