Skip to content

Fix Inventory#addItem javadoc mismatch with behaviour #11782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lynxplay merged 2 commits into from
Dec 23, 2024
Merged

Fix Inventory#addItem javadoc mismatch with behaviour #11782

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
720f698
Fix Inventory#addItem javadoc mismatch with behaviour
masmc05 Dec 23, 2024
0c5fe03
Try to improve the wording
masmc05 Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions paper-api/src/main/java/org/bukkit/inventory/Inventory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,12 @@ public interface Inventory extends Iterable<ItemStack> {
* index of the varargs parameter. If all items are stored, it will return
* an empty HashMap.
* <p>
* If you pass in ItemStacks which exceed the maximum stack size for the
* Material, first they will be added to partial stacks where
* Material.getMaxStackSize() is not exceeded, up to
* 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.
* Items resulted from this method will not exceed the minimum
* of {@link ItemStack#getMaxStackSize()} and {@link #getMaxStackSize()}.
* <p>
* First, this method will try to fill all the partial stacks in the inventory.
* Then it will try to fill empty slots, over-stacked items being able to
* fill several empty slots. The rest are placed in the returned map.
* <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
Expand Down