summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/bukkit/inventory/PlayerInventory.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/bukkit/inventory/PlayerInventory.java')
-rw-r--r--src/main/java/org/bukkit/inventory/PlayerInventory.java26
1 files changed, 14 insertions, 12 deletions
diff --git a/src/main/java/org/bukkit/inventory/PlayerInventory.java b/src/main/java/org/bukkit/inventory/PlayerInventory.java
index 7eb5c985..d18c9f40 100644
--- a/src/main/java/org/bukkit/inventory/PlayerInventory.java
+++ b/src/main/java/org/bukkit/inventory/PlayerInventory.java
@@ -3,7 +3,7 @@ package org.bukkit.inventory;
import org.bukkit.entity.HumanEntity;
/**
- * Includes interface to the 4 armor slots
+ * Interface to the inventory of a Player, including the four armor slots.
*/
public interface PlayerInventory extends Inventory {
@@ -50,32 +50,32 @@ public interface PlayerInventory extends Inventory {
public void setArmorContents(ItemStack[] items);
/**
- * Put the given ItemStack into the helmet slot
- * This does not check if the ItemStack is a helmet
+ * Put the given ItemStack into the helmet slot. This does not check if
+ * the ItemStack is a helmet
*
* @param helmet The ItemStack to use as helmet
*/
public void setHelmet(ItemStack helmet);
/**
- * Put the given ItemStack into the chestplate slot
- * This does not check if the ItemStack is a chestplate
+ * Put the given ItemStack into the chestplate slot. This does not check
+ * if the ItemStack is a chestplate
*
* @param chestplate The ItemStack to use as chestplate
*/
public void setChestplate(ItemStack chestplate);
/**
- * Put the given ItemStack into the leg slot
- * This does not check if the ItemStack is a pair of leggings
+ * Put the given ItemStack into the leg slot. This does not check if the
+ * ItemStack is a pair of leggings
*
* @param leggings The ItemStack to use as leggings
*/
public void setLeggings(ItemStack leggings);
/**
- * Put the given ItemStack into the boots slot
- * This does not check if the ItemStack is a boots
+ * Put the given ItemStack into the boots slot. This does not check if the
+ * ItemStack is a boots
*
* @param boots The ItemStack to use as boots
*/
@@ -108,13 +108,15 @@ public interface PlayerInventory extends Inventory {
* This validates whether the slot is between 0 and 8 inclusive.
*
* @param slot The new slot number
- * @throws IllegalArgumentException Thrown if slot is not between 0 and 8 inclusive
+ * @throws IllegalArgumentException Thrown if slot is not between 0 and 8
+ * inclusive
*/
public void setHeldItemSlot(int slot);
/**
- * Clears all matching items from the inventory. Setting either value to -1 will skip it's check,
- * while setting both to -1 will clear all items in your inventory unconditionally.
+ * Clears all matching items from the inventory. Setting either value to
+ * -1 will skip it's check, while setting both to -1 will clear all items
+ * in your inventory unconditionally.
*
* @param id the id of the item you want to clear from the inventory
* @param data the data of the item you want to clear from the inventory