twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-15 12:13:54 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add some Inventory addItem / removeItem notes

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2016-03-28 16:31:57 +11:00
parent 07917efd4a
commit e9ec8e1b58
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
paper-api/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 * Material.getMaxStackSize(). When there are no partial stacks left
* stacks will be split on Inventory.getMaxStackSize() allowing you to * stacks will be split on Inventory.getMaxStackSize() allowing you to
* exceed the maximum stack size for that material. * 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 * @param items The ItemStacks to add
* @return A HashMap containing items that didn't fit. * @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 * the index of the parameter, and the value is the ItemStack at that
* index of the varargs parameter. If all the given ItemStacks are * index of the varargs parameter. If all the given ItemStacks are
* removed, it will return an empty HashMap. * 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 * @param items The ItemStacks to remove
* @return A HashMap containing items that couldn't be removed. * @return A HashMap containing items that couldn't be removed.