summaryrefslogtreecommitdiffstats
path: root/src/main
diff options
context:
space:
mode:
authormd_5 <git@md-5.net>2016-03-28 16:31:57 +1100
committermd_5 <git@md-5.net>2016-03-28 16:38:00 +1100
commit56605a05f6c85762d46b0b76b9eb20cfc7991e7e (patch)
tree1b720b5cd47fa8fa0c69cf4df4199d267bd64c60 /src/main
parent21df80186f60e6f13ac9191c9f604a76b1b0b9d5 (diff)
downloadbukkit-56605a05f6c85762d46b0b76b9eb20cfc7991e7e.tar
bukkit-56605a05f6c85762d46b0b76b9eb20cfc7991e7e.tar.gz
bukkit-56605a05f6c85762d46b0b76b9eb20cfc7991e7e.tar.lz
bukkit-56605a05f6c85762d46b0b76b9eb20cfc7991e7e.tar.xz
bukkit-56605a05f6c85762d46b0b76b9eb20cfc7991e7e.zip
Add some Inventory addItem / removeItem notes
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/org/bukkit/inventory/Inventory.java8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/main/java/org/bukkit/inventory/Inventory.java b/src/main/java/org/bukkit/inventory/Inventory.java
index 5832e245..3275e172 100644
--- a/src/main/java/org/bukkit/inventory/Inventory.java
+++ b/src/main/java/org/bukkit/inventory/Inventory.java
@@ -85,6 +85,10 @@ public interface Inventory extends Iterable<ItemStack> {
* Material.getMaxStackSize(). When there are no partial stacks left
* stacks will be split on Inventory.getMaxStackSize() allowing you to
* exceed the maximum stack size for that material.
+ * <p>
+ * It is known that in some implementations this method will also set
+ * the inputted argument amount to the number of that item not placed in
+ * slots.
*
* @param items The ItemStacks to add
* @return A HashMap containing items that didn't fit.
@@ -102,6 +106,10 @@ public interface Inventory extends Iterable<ItemStack> {
* the index of the parameter, and the value is the ItemStack at that
* index of the varargs parameter. If all the given ItemStacks are
* removed, it will return an empty HashMap.
+ * <p>
+ * It is known that in some implementations this method will also set the
+ * inputted argument amount to the number of that item not removed from
+ * slots.
*
* @param items The ItemStacks to remove
* @return A HashMap containing items that couldn't be removed.