Updated inventories to a has-a relationship.

Added PlayerInventory interface with playeronly methods. Add equals to ItemStack. By: Erik Broes <erikbroes@grum.nl>
2011-01-09 18:21:31 +01:00
parent f81c44fbba
commit f95c139dd6
6 changed files with 237 additions and 50 deletions
@@ -0,0 +1,82 @@
+package org.bukkit;
+
+import java.util.ArrayList;
+
+/**
+ * Includes interface to the 4 armor slots
+ */
+public interface PlayerInventory extends Inventory {
+    /**
+     * Get all ItemStacks from the armor slots
+     * 
+     * @return All the ItemStacks from the armor slots
+     */
+    public ArrayList<ItemStack> getArmorContents();
+
+    /**
+     * Return the ItemStack from the helmet slot
+     * 
+     * @return The ItemStack in the helmet slot
+     */
+    public ItemStack getHelmet();
+
+    /**
+     * Return the ItemStack from the chestplate slot
+     * 
+     * @return The ItemStack in the chestplate slot
+     */
+    public ItemStack getChestplate();
+
+    /**
+     * Return the ItemStack from the leg slot
+     * 
+     * @return The ItemStack in the leg slot
+     */
+    public ItemStack getLeggings();
+
+    /**
+     * Return the ItemStack from the boots slot
+     * 
+     * @return The ItemStack in the boots slot
+     */
+    public ItemStack getBoots();
+
+    /**
+     * 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
+     * 
+     * @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
+     * 
+     * @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
+     * 
+     * @param boots The ItemStack to use as boots
+     */
+    public void setBoots(ItemStack boots);
+
+    /**
+     * Returns the ItemStack currently hold
+     * 
+     * @return The currently holded ItemStack
+     */
+    public ItemStack getItemInHand();
+}