PlayerInventory (Spigot-API 1.12.2-R0.1-SNAPSHOT API)

All Superinterfaces:

Inventory, java.lang.Iterable<ItemStack>
```
public interface PlayerInventory
extends Inventory
```
Interface to the inventory of a Player, including the four armor slots and any extra slots.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`clear(int id, int data)`	Deprecated. Magic value
`ItemStack[]`	`getArmorContents()`	Get all ItemStacks from the armor slots
`ItemStack`	`getBoots()`	Return the ItemStack from the boots slot
`ItemStack`	`getChestplate()`	Return the ItemStack from the chestplate slot
`ItemStack[]`	`getExtraContents()`	Get all additional ItemStacks stored in this inventory.
`int`	`getHeldItemSlot()`	Get the slot number of the currently held item
`ItemStack`	`getHelmet()`	Return the ItemStack from the helmet slot
`HumanEntity`	`getHolder()`	Gets the block or entity belonging to the open inventory
`ItemStack`	`getItemInHand()`	Deprecated. players can duel wield now use the methods for the specific hand instead
`ItemStack`	`getItemInMainHand()`	Gets a copy of the item the player is currently holding in their main hand.
`ItemStack`	`getItemInOffHand()`	Gets a copy of the item the player is currently holding in their off hand.
`ItemStack`	`getLeggings()`	Return the ItemStack from the leg slot
`void`	`setArmorContents(ItemStack[] items)`	Put the given ItemStacks into the armor slots
`void`	`setBoots(ItemStack boots)`	Put the given ItemStack into the boots slot.
`void`	`setChestplate(ItemStack chestplate)`	Put the given ItemStack into the chestplate slot.
`void`	`setExtraContents(ItemStack[] items)`	Put the given ItemStacks into the extra slots See `getExtraContents()` for an explanation of extra slots.
`void`	`setHeldItemSlot(int slot)`	Set the slot number of the currently held item.
`void`	`setHelmet(ItemStack helmet)`	Put the given ItemStack into the helmet slot.
`void`	`setItem(int index, ItemStack item)`	Stores the ItemStack at the given index of the inventory.
`void`	`setItemInHand(ItemStack stack)`	Deprecated. players can duel wield now use the methods for the specific hand instead
`void`	`setItemInMainHand(ItemStack item)`	Sets the item the player is holding in their main hand.
`void`	`setItemInOffHand(ItemStack item)`	Sets the item the player is holding in their off hand.
`void`	`setLeggings(ItemStack leggings)`	Put the given ItemStack into the leg slot.

Methods inherited from interface org.bukkit.inventory.Inventory
addItem, all, all, all, clear, clear, contains, contains, contains, contains, contains, contains, containsAtLeast, first, first, first, firstEmpty, getContents, getItem, getLocation, getMaxStackSize, getName, getSize, getStorageContents, getTitle, getType, getViewers, iterator, iterator, remove, remove, remove, removeItem, setContents, setMaxStackSize, setStorageContents

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - getArmorContents
```
ItemStack[] getArmorContents()
```
    Get all ItemStacks from the armor slots
    
    Returns:
    
    All the ItemStacks from the armor slots
  - getExtraContents
```
ItemStack[] getExtraContents()
```
    Get all additional ItemStacks stored in this inventory.
    NB: What defines an extra slot is up to the implementation, however it will not be contained within Inventory.getStorageContents() or getArmorContents()
    
    Returns:
    
    All additional ItemStacks
  - getHelmet
```
ItemStack getHelmet()
```
    Return the ItemStack from the helmet slot
    
    Returns:
    
    The ItemStack in the helmet slot
  - getChestplate
```
ItemStack getChestplate()
```
    Return the ItemStack from the chestplate slot
    
    Returns:
    
    The ItemStack in the chestplate slot
  - getLeggings
```
ItemStack getLeggings()
```
    Return the ItemStack from the leg slot
    
    Returns:
    
    The ItemStack in the leg slot
  - getBoots
```
ItemStack getBoots()
```
    Return the ItemStack from the boots slot
    
    Returns:
    
    The ItemStack in the boots slot
  - setItem
```
void setItem(int index,
             ItemStack item)
```
    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.
    
    Specified by:
    
    setItem in interface Inventory
    
    Parameters:
    
    index - The index where to put the ItemStack
    
    item - The ItemStack to set
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - when index < 0 || index > 39
    
    See Also:
    
    setBoots(ItemStack), setChestplate(ItemStack), setHelmet(ItemStack), setLeggings(ItemStack)
  - setArmorContents
```
void setArmorContents(ItemStack[] items)
```
    Put the given ItemStacks into the armor slots
    
    Parameters:
    
    items - The ItemStacks to use as armour
  - setExtraContents
```
void setExtraContents(ItemStack[] items)
```
    Put the given ItemStacks into the extra slots
    See getExtraContents() for an explanation of extra slots.
    
    Parameters:
    
    items - The ItemStacks to use as extra
  - setHelmet
```
void setHelmet(ItemStack helmet)
```
    Put the given ItemStack into the helmet slot. This does not check if the ItemStack is a helmet
    
    Parameters:
    
    helmet - The ItemStack to use as helmet
  - setChestplate
```
void setChestplate(ItemStack chestplate)
```
    Put the given ItemStack into the chestplate slot. This does not check if the ItemStack is a chestplate
    
    Parameters:
    
    chestplate - The ItemStack to use as chestplate
  - setLeggings
```
void setLeggings(ItemStack leggings)
```
    Put the given ItemStack into the leg slot. This does not check if the ItemStack is a pair of leggings
    
    Parameters:
    
    leggings - The ItemStack to use as leggings
  - setBoots
```
void setBoots(ItemStack boots)
```
    Put the given ItemStack into the boots slot. This does not check if the ItemStack is a boots
    
    Parameters:
    
    boots - The ItemStack to use as boots
  - getItemInMainHand
```
ItemStack getItemInMainHand()
```
    Gets a copy of the item the player is currently holding in their main hand.
    
    Returns:
    
    the currently held item
  - setItemInMainHand
```
void setItemInMainHand(ItemStack item)
```
    Sets the item the player is holding in their main hand.
    
    Parameters:
    
    item - The item to put into the player's hand
  - getItemInOffHand
```
ItemStack getItemInOffHand()
```
    Gets a copy of the item the player is currently holding in their off hand.
    
    Returns:
    
    the currently held item
  - setItemInOffHand
```
void setItemInOffHand(ItemStack item)
```
    Sets the item the player is holding in their off hand.
    
    Parameters:
    
    item - The item to put into the player's hand
  - getItemInHand
```
@Deprecated
ItemStack getItemInHand()
```
    Deprecated.
    players can duel wield now use the methods for the specific hand instead
    
    Gets a copy of the item the player is currently holding
    
    Returns:
    
    the currently held item
    
    See Also:
    
    getItemInMainHand(), getItemInOffHand()
  - setItemInHand
```
@Deprecated
void setItemInHand(ItemStack stack)
```
    Deprecated.
    players can duel wield now use the methods for the specific hand instead
    
    Sets the item the player is holding
    
    Parameters:
    
    stack - The item to put into the player's hand
    
    See Also:
    
    setItemInMainHand(ItemStack), setItemInOffHand(ItemStack)
  - getHeldItemSlot
```
int getHeldItemSlot()
```
    Get the slot number of the currently held item
    
    Returns:
    
    Held item slot number
  - setHeldItemSlot
```
void setHeldItemSlot(int slot)
```
    Set the slot number of the currently held item.
    This validates whether the slot is between 0 and 8 inclusive.
    
    Parameters:
    
    slot - The new slot number
    
    Throws:
    
    java.lang.IllegalArgumentException - Thrown if slot is not between 0 and 8 inclusive
  - clear
```
@Deprecated
int clear(int id,
          int data)
```
    Deprecated.
    Magic value
    
    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.
    
    Parameters:
    
    id - the id of the item you want to clear from the inventory
    
    data - the data of the item you want to clear from the inventory
    
    Returns:
    
    The number of items cleared
  - getHolder
```
HumanEntity getHolder()
```
    Description copied from interface: Inventory
    
    Gets the block or entity belonging to the open inventory
    
    Specified by:
    
    getHolder in interface Inventory
    
    Returns:
    
    The holder of the inventory; null if it has no holder.

Interface PlayerInventory

Method Summary

Methods inherited from interface org.bukkit.inventory.Inventory

Methods inherited from interface java.lang.Iterable

Method Detail

getArmorContents

getExtraContents

getHelmet

getChestplate

getLeggings

getBoots

setItem

setArmorContents

setExtraContents

setHelmet

setChestplate

setLeggings

setBoots

getItemInMainHand

setItemInMainHand

getItemInOffHand

setItemInOffHand

getItemInHand

setItemInHand

getHeldItemSlot

setHeldItemSlot

clear

getHolder