spigot-mirror/bukkit
1
0
Fork 0
mirror of https://hub.spigotmc.org/stash/scm/spigot/bukkit.git synced 2025-08-31 22:22:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add some Inventory addItem / removeItem notes

Browse source
This commit is contained in:
md_5 2016-03-28 16:31:57 +11:00
parent 21df80186f
commit 56605a05f6
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/main/java/org/bukkit/inventory/Inventory.java
View file

@ -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.