From b465559cb5e8ff4fb028f61e7a740788e3f0b0f2 Mon Sep 17 00:00:00 2001 From: DemonWav Date: Thu, 21 May 2015 17:17:41 -0500 Subject: Add more detailed documentation for setItem() in PlayerInventory --- .../java/org/bukkit/inventory/PlayerInventory.java | 24 ++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'src/main/java') diff --git a/src/main/java/org/bukkit/inventory/PlayerInventory.java b/src/main/java/org/bukkit/inventory/PlayerInventory.java index d18c9f40..5dd3ae7a 100644 --- a/src/main/java/org/bukkit/inventory/PlayerInventory.java +++ b/src/main/java/org/bukkit/inventory/PlayerInventory.java @@ -42,6 +42,30 @@ public interface PlayerInventory extends Inventory { */ public ItemStack getBoots(); + /** + * Stores the ItemStack at the given index of the inventory. + *

+ * 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. + *

+ * 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. + *

+ * 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 * -- cgit v1.2.3