summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI/Inheritance
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2016-11-04 20:13:58 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2016-11-04 20:13:58 -0400
commitb7b69707eb83fac01b30ad5b94bb8a2672fc2180 (patch)
treed325328b37f7c84e87b903b4ffea0700aea5f148 /src/StardewModdingAPI/Inheritance
parentea0550028c5e1a473b4e4547610812b8921e218f (diff)
downloadSMAPI-b7b69707eb83fac01b30ad5b94bb8a2672fc2180.tar.gz
SMAPI-b7b69707eb83fac01b30ad5b94bb8a2672fc2180.tar.bz2
SMAPI-b7b69707eb83fac01b30ad5b94bb8a2672fc2180.zip
document inventory changed event objects
Diffstat (limited to 'src/StardewModdingAPI/Inheritance')
-rw-r--r--src/StardewModdingAPI/Inheritance/ChangeType.cs6
-rw-r--r--src/StardewModdingAPI/Inheritance/ItemStackChange.cs9
2 files changed, 15 insertions, 0 deletions
diff --git a/src/StardewModdingAPI/Inheritance/ChangeType.cs b/src/StardewModdingAPI/Inheritance/ChangeType.cs
index 4eaa02af..94eb33ed 100644
--- a/src/StardewModdingAPI/Inheritance/ChangeType.cs
+++ b/src/StardewModdingAPI/Inheritance/ChangeType.cs
@@ -1,9 +1,15 @@
namespace StardewModdingAPI.Inheritance
{
+ /// <summary>Indicates how an inventory item changed.</summary>
public enum ChangeType
{
+ /// <summary>The entire stack was removed.</summary>
Removed,
+
+ /// <summary>The entire stack was added.</summary>
Added,
+
+ /// <summary>The stack size changed.</summary>
StackChange
}
} \ No newline at end of file
diff --git a/src/StardewModdingAPI/Inheritance/ItemStackChange.cs b/src/StardewModdingAPI/Inheritance/ItemStackChange.cs
index 8abe3a76..8d15b894 100644
--- a/src/StardewModdingAPI/Inheritance/ItemStackChange.cs
+++ b/src/StardewModdingAPI/Inheritance/ItemStackChange.cs
@@ -2,10 +2,19 @@
namespace StardewModdingAPI.Inheritance
{
+ /// <summary>Represents an inventory slot that changed.</summary>
public class ItemStackChange
{
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The item in the slot.</summary>
public Item Item { get; set; }
+
+ /// <summary>The amount by which the item's stack size changed.</summary>
public int StackChange { get; set; }
+
+ /// <summary>How the inventory slot changed.</summary>
public ChangeType ChangeType { get; set; }
}
} \ No newline at end of file