summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/SnapshotItemListDiff.cs
blob: 76060db2f631036e5dbca4de02d4ec1c3017eba5 (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
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using StardewModdingAPI.Events;
using StardewValley;

namespace StardewModdingAPI.Framework
{
    /// <summary>A snapshot of a tracked item list.</summary>
    internal class SnapshotItemListDiff
    {
        /*********
        ** Accessors
        *********/
        /// <summary>Whether the item list changed.</summary>
        public bool IsChanged { get; }

        /// <summary>The removed values.</summary>
        public Item[] Removed { get; }

        /// <summary>The added values.</summary>
        public Item[] Added { get; }

        /// <summary>The items whose stack sizes changed.</summary>
        public ItemStackSizeChange[] QuantityChanged { get; }


        /*********
        ** Public methods
        *********/
        /// <summary>Update the snapshot.</summary>
        /// <param name="added">The added values.</param>
        /// <param name="removed">The removed values.</param>
        /// <param name="sizesChanged">The items whose stack sizes changed.</param>
        public SnapshotItemListDiff(Item[] added, Item[] removed, ItemStackSizeChange[] sizesChanged)
        {
            this.Removed = removed;
            this.Added = added;
            this.QuantityChanged = sizesChanged;

            this.IsChanged = removed.Length > 0 || added.Length > 0 || sizesChanged.Length > 0;
        }

        /// <summary>Get a snapshot diff if anything changed in the given data.</summary>
        /// <param name="added">The added item stacks.</param>
        /// <param name="removed">The removed item stacks.</param>
        /// <param name="stackSizes">The items with their previous stack sizes.</param>
        /// <param name="changes">The inventory changes, or <c>null</c> if nothing changed.</param>
        /// <returns>Returns whether anything changed.</returns>
        public static bool TryGetChanges(ISet<Item> added, ISet<Item> removed, IDictionary<Item, int> stackSizes, [NotNullWhen(true)] out SnapshotItemListDiff? changes)
        {
            KeyValuePair<Item, int>[] sizesChanged = stackSizes.Where(p => p.Key.Stack != p.Value).ToArray();
            if (sizesChanged.Any() || added.Any() || removed.Any())
            {
                changes = new SnapshotItemListDiff(
                    added: added.ToArray(),
                    removed: removed.ToArray(),
                    sizesChanged: sizesChanged.Select(p => new ItemStackSizeChange(p.Key, p.Value, p.Key.Stack)).ToArray()
                );
                return true;
            }

            changes = null;
            return false;
        }
    }
}