summaryrefslogtreecommitdiff
path: root/src/SMAPI/Events/InventoryChangedEventArgs.cs
blob: 58c0ff8f171c7821e8539e59c67a295e91a04fc4 (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
#nullable disable

using System;
using System.Collections.Generic;
using StardewValley;

namespace StardewModdingAPI.Events
{
    /// <summary>Event arguments for an <see cref="IPlayerEvents.InventoryChanged"/> event.</summary>
    public class InventoryChangedEventArgs : EventArgs
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The player whose inventory changed.</summary>
        public Farmer Player { get; }

        /// <summary>The added item stacks.</summary>
        public IEnumerable<Item> Added { get; }

        /// <summary>The removed item stacks.</summary>
        public IEnumerable<Item> Removed { get; }

        /// <summary>The item stacks whose size changed.</summary>
        public IEnumerable<ItemStackSizeChange> QuantityChanged { get; }

        /// <summary>Whether the affected player is the local one.</summary>
        public bool IsLocalPlayer => this.Player.IsLocalPlayer;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="player">The player whose inventory changed.</param>
        /// <param name="added">The added item stacks.</param>
        /// <param name="removed">The removed item stacks.</param>
        /// <param name="quantityChanged">The item stacks whose size changed.</param>
        internal InventoryChangedEventArgs(Farmer player, Item[] added, Item[] removed, ItemStackSizeChange[] quantityChanged)
        {
            this.Player = player;
            this.Added = added;
            this.Removed = removed;
            this.QuantityChanged = quantityChanged;
        }
    }
}