f95c139dd6
Added PlayerInventory interface with playeronly methods. Add equals to ItemStack. By: Erik Broes <erikbroes@grum.nl>
135 lines
3.7 KiB
Java
135 lines
3.7 KiB
Java
package org.bukkit;
|
|
|
|
import java.util.HashMap;
|
|
|
|
/**
|
|
* Interface to the various inventories
|
|
*/
|
|
public interface Inventory {
|
|
/**
|
|
* Returns the size of the inventory
|
|
*
|
|
* @return The inventory size
|
|
*/
|
|
public int getSize();
|
|
|
|
/**
|
|
* Return the name of the inventory
|
|
*
|
|
* @return The inventory name
|
|
*/
|
|
public String getName();
|
|
|
|
/**
|
|
* Get the ItemStack found in the slot at the given index
|
|
*
|
|
* @param index The index of the Slot's ItemStack to return
|
|
* @return The ItemStack in the slot
|
|
*/
|
|
public ItemStack getItem(int index);
|
|
|
|
/**
|
|
* Stores the ItemStack at the given index
|
|
*
|
|
* @param index The index where to put the ItemStack
|
|
* @param item The ItemStack to set
|
|
*/
|
|
public void setItem(int index, ItemStack item);
|
|
|
|
/**
|
|
* Stores the given ItemStacks in the inventory
|
|
*
|
|
* @param items The ItemStacks to add
|
|
* @return
|
|
*/
|
|
public HashMap<Integer, ItemStack> addItem(ItemStack... items);
|
|
|
|
/**
|
|
* Get all ItemStacks from the inventory
|
|
*
|
|
* @return All the ItemStacks from all slots
|
|
*/
|
|
public ItemStack[] getContents();
|
|
|
|
/**
|
|
* Check if the inventory contains any ItemStacks with the given materialId
|
|
*
|
|
* @param materialId The materialId to check for
|
|
* @return If any ItemStacks were found
|
|
*/
|
|
public boolean contains(int materialId);
|
|
|
|
/**
|
|
* Check if the inventory contains any ItemStacks with the given material
|
|
*
|
|
* @param material The material to check for
|
|
* @return If any ItemStacks were found
|
|
*/
|
|
public boolean contains(Material material);
|
|
|
|
/**
|
|
* Check if the inventory contains any ItemStacks matching the given ItemStack
|
|
* This will only match if both the type and the amount of the stack match
|
|
*
|
|
* @param item The ItemStack to match against
|
|
* @return If any matching ItemStacks were found
|
|
*/
|
|
public boolean contains(ItemStack item);
|
|
|
|
/**
|
|
* Find all slots in the inventory containing any ItemStacks with the given materialId
|
|
*
|
|
* @param materialId The materialId to look for
|
|
* @return The Slots found.
|
|
*/
|
|
public HashMap<Integer,ItemStack> all(int materialId);
|
|
|
|
/**
|
|
* Find all slots in the inventory containing any ItemStacks with the given material
|
|
*
|
|
* @param materialId The material to look for
|
|
* @return The Slots found.
|
|
*/
|
|
public HashMap<Integer,ItemStack> all(Material material);
|
|
|
|
/**
|
|
* Find all slots in the inventory containing any ItemStacks with the given ItemStack
|
|
* This will only match slots if both the type and the amount of the stack match
|
|
*
|
|
* @param item The ItemStack to match against
|
|
* @return The Slots found.
|
|
*/
|
|
public HashMap<Integer,ItemStack> all(ItemStack item);
|
|
|
|
/**
|
|
* Find the first slot in the inventory containing an ItemStack with the given materialId
|
|
*
|
|
* @param materialId The materialId to look for
|
|
* @return The Slot found.
|
|
*/
|
|
public int first(int materialId);
|
|
|
|
/**
|
|
* Find the first slot in the inventory containing an ItemStack with the given material
|
|
*
|
|
* @param materialId The material to look for
|
|
* @return The Slot found.
|
|
*/
|
|
public int first(Material material);
|
|
|
|
/**
|
|
* Find the first slot in the inventory containing an ItemStack with the given stack
|
|
* This will only match a slot if both the type and the amount of the stack match
|
|
*
|
|
* @param item The ItemStack to match against
|
|
* @return The Slot found.
|
|
*/
|
|
public int first(ItemStack item);
|
|
|
|
/**
|
|
* Find the first empty Slot.
|
|
*
|
|
* @return The first empty Slot found.
|
|
*/
|
|
public int firstEmpty();
|
|
} |