OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-09 19:49:35 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add more detailed documentation for setItem() in PlayerInventory

Browse source 
By: DemonWav <demonwav@gmail.com>
This commit is contained in:
Bukkit/Spigot 2015-05-21 17:17:41 -05:00
parent f6175ea588
commit 4dea166df4
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java
View file

@ -42,6 +42,30 @@ public interface PlayerInventory extends Inventory {
*/
public ItemStack getBoots();
/**
* Stores the ItemStack at the given index of the inventory.
* <p>
* Indexes 0 through 8 refer to the hotbar. 9 through 35 refer to the main inventory, counting up from 9 at the top
* left corner of the inventory, moving to the right, and moving to the row below it back on the left side when it
* reaches the end of the row. It follows the same path in the inventory like you would read a book.
* <p>
* Indexes 36 through 39 refer to the armor slots. Though you can set armor with this method using these indexes,
* you are encouraged to use the provided methods for those slots.
* <p>
* If you attempt to use this method with an index less than 0 or greater than 39, an ArrayIndexOutOfBounds
* exception will be thrown.
*
* @param index The index where to put the ItemStack
* @param item The ItemStack to set
* @throws ArrayIndexOutOfBoundsException when index < 0 || index > 39
* @see #setBoots(ItemStack)
* @see #setChestplate(ItemStack)
* @see #setHelmet(ItemStack)
* @see #setLeggings(ItemStack)
*/
@Override
public void setItem(int index, ItemStack item);
/**
* Put the given ItemStacks into the armor slots
*