Interface PlayerInventory
-
Method Summary
Modifier and TypeMethodDescriptionGets all ItemStacks from the armor slots.getBoots()
Return the ItemStack from the boots slotReturn the ItemStack from the chestplate slotGet all additional ItemStacks stored in this inventory.int
Get the slot number of the currently held itemReturn the ItemStack from the helmet slotGets the block or entity belonging to the open inventorygetItem
(@NotNull EquipmentSlot slot) Gets the ItemStack at the given equipment slot in the inventory.Deprecated.players can duel wield now use the methods for the specific hand insteadGets the item the player is currently holding in their main hand.Gets the item the player is currently holding in their off hand.Return the ItemStack from the leg slotvoid
setArmorContents
(@Nullable ItemStack[] items) Put the given ItemStacks into the armor slotsvoid
Put the given ItemStack into the boots slot.void
setChestplate
(@Nullable ItemStack chestplate) Put the given ItemStack into the chestplate slot.void
setExtraContents
(@Nullable ItemStack[] items) Put the given ItemStacks into the extra slots
SeegetExtraContents()
for an explanation of extra slots.void
setHeldItemSlot
(int slot) Set the slot number of the currently held item.void
Put the given ItemStack into the helmet slot.void
Stores the ItemStack at the given index of the inventory.void
setItem
(@NotNull EquipmentSlot slot, @Nullable ItemStack item) Stores the ItemStack at the given equipment slot in the inventory.void
setItemInHand
(@Nullable ItemStack stack) Deprecated.players can duel wield now use the methods for the specific hand insteadvoid
Sets the item the player is holding in their main hand.void
Sets the item the player is holding in their off hand.void
setLeggings
(@Nullable ItemStack leggings) Put the given ItemStack into the leg slot.Methods inherited from interface org.bukkit.inventory.Inventory
addItem, all, all, clear, clear, close, contains, contains, contains, contains, containsAtLeast, first, first, firstEmpty, getContents, getHolder, getItem, getLocation, getMaxStackSize, getSize, getStorageContents, getType, getViewers, isEmpty, iterator, iterator, remove, remove, removeItem, removeItemAnySlot, setContents, setMaxStackSize, setStorageContents
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
getArmorContents
Gets all ItemStacks from the armor slots.- Returns:
- all the ItemStacks from the armor slots. Individual items can be null and are returned in a fixed order starting from the boots and going up to the helmet
-
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 withinInventory.getStorageContents()
orgetArmorContents()
- Returns:
- All additional ItemStacks. Individual items can be null.
-
getHelmet
Return the ItemStack from the helmet slot- Returns:
- The ItemStack in the helmet slot
-
getChestplate
Return the ItemStack from the chestplate slot- Returns:
- The ItemStack in the chestplate slot
-
getLeggings
Return the ItemStack from the leg slot- Returns:
- The ItemStack in the leg slot
-
getBoots
Return the ItemStack from the boots slot- Returns:
- The ItemStack in the boots slot
-
setItem
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.
Index 40 refers to the off hand (shield) item slot. Though you can set off hand with this method using this index, you are encouraged to use the provided method for this slot.
If you attempt to use this method with an index less than 0 or greater than 40, an ArrayIndexOutOfBounds exception will be thrown.
- Specified by:
setItem
in interfaceInventory
- Parameters:
index
- The index where to put the ItemStackitem
- The ItemStack to set- Throws:
ArrayIndexOutOfBoundsException
- when index < 0 || index > 40- See Also:
-
setItem
Stores the ItemStack at the given equipment slot in the inventory.- Parameters:
slot
- the slot to put the ItemStackitem
- the ItemStack to set- Throws:
IllegalArgumentException
- if the slot is invalid for the player- See Also:
-
getItem
Gets the ItemStack at the given equipment slot in the inventory.- Parameters:
slot
- the slot to get the ItemStack- Returns:
- the ItemStack in the given slot
- Throws:
IllegalArgumentException
- if the slot is invalid for the player- See Also:
-
setArmorContents
Put the given ItemStacks into the armor slots- Parameters:
items
- The ItemStacks to use as armour
-
setExtraContents
Put the given ItemStacks into the extra slots
SeegetExtraContents()
for an explanation of extra slots.- Parameters:
items
- The ItemStacks to use as extra
-
setHelmet
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
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
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
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
Gets the item the player is currently holding in their main hand.- Returns:
- the currently held item
-
setItemInMainHand
Sets the item the player is holding in their main hand.- Parameters:
item
- The item to put into the player's hand
-
getItemInOffHand
Gets the item the player is currently holding in their off hand.- Returns:
- the currently held item
-
setItemInOffHand
Sets the item the player is holding in their off hand.- Parameters:
item
- The item to put into the player's hand
-
getItemInHand
Deprecated.players can duel wield now use the methods for the specific hand insteadGets the item the player is currently holding- Returns:
- the currently held item
- See Also:
-
setItemInHand
Deprecated.players can duel wield now use the methods for the specific hand insteadSets the item the player is holding- Parameters:
stack
- The item to put into the player's hand- See Also:
-
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:
IllegalArgumentException
- Thrown if slot is not between 0 and 8 inclusive
-
getHolder
Description copied from interface:Inventory
Gets the block or entity belonging to the open inventory
-