Bukkit Inventory Slot Numbers

7/6/2022

All Superinterfaces:: Inventory, Iterable<ItemStack>

Interface to the inventory of a Player, including the four armor slots and any extra slots.

Method Summary

Modifier and Type	Method	Description
`ItemStack[]`	`getArmorContents()`
`ItemStack`	`getBoots()`	Return the ItemStack from the boots slot
`ItemStack`	`getChestplate()`
`ItemStack[]`	`getExtraContents()`	Get all additional ItemStacks stored in this inventory.
`int`	`getHeldItemSlot()`
`ItemStack`	`getHelmet()`	Return the ItemStack from the helmet slot
`HumanEntity`	`getHolder()`	Gets the block or entity belonging to the open inventory
`ItemStack`	`getItem(EquipmentSlot slot)`	Gets the ItemStack at the given equipment slot in the inventory.
`ItemStack`	`getItemInHand()`	Deprecated. players can duel wield now use the methods for thespecific hand instead
`ItemStack`	`getItemInMainHand()`	Gets a copy of the item the player is currently holdingin their main hand.
`ItemStack`	`getItemInOffHand()`	Gets a copy of the item the player is currently holdingin their off hand.
`ItemStack`	`getLeggings()`
`void`	`setArmorContents(ItemStack[] items)`	Put the given ItemStacks into the armor slots
`void`	`setBoots(ItemStack boots)`
`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)`
`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`	`setItem(EquipmentSlot slot,ItemStack item)`	Stores the ItemStack at the given equipment slot in the inventory.
`void`	`setItemInHand(ItemStack stack)`	Deprecated. players can duel wield now use the methods for thespecific 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)`

Methods inherited from interface org.bukkit.inventory.Inventory

addItem, all, all, clear, clear, contains, contains, contains, contains, containsAtLeast, first, first, firstEmpty, getContents, getItem, getLocation, getMaxStackSize, getSize, getStorageContents, getType, getViewers, isEmpty, iterator, iterator, remove, remove, removeItem, setContents, setMaxStackSize, setStorageContents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Configuration info: shop-lines: 3 # Number of shop GUI lines. Maximum is 6 (54 slots) fill-empty: true # Put items in free inventory slot instead of adding items to existing stack. 'INKSACK-3': # ItemName-Durability (-durability is optional) amount: 2 # Amount of items to add to player inventory when buy. A player's inventory, with 9 QUICKBAR slots, 27 CONTAINER slots, 4 ARMOR slots and 1 offhand slot. The ARMOR and offhand slots may not be visible to the player, though.

Method Details
- getArmorContents
  Get all ItemStacks from the armor slots
  Returns:
  All the ItemStacks from the armor slots. Individual items can be null.
- getExtraContents
  Get all additional ItemStacks stored in this inventory.
  NB: What defines an extra slot is up to the implementation, however itwill not be contained within Inventory.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 topleft corner of the inventory, moving to the right, and moving to the row below it back on the left side when itreaches 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 ArrayIndexOutOfBoundsexception will be thrown.
  Specified by:
  setItem in interface Inventory
  Parameters:
  index - The index where to put the ItemStack
  item - The ItemStack to set
  Throws:
  ArrayIndexOutOfBoundsException - when index < 0 index > 40
  See Also:
  setBoots(ItemStack),setChestplate(ItemStack),setHelmet(ItemStack),setLeggings(ItemStack),setItemInOffHand(ItemStack)
- setItem
  voidsetItem(@NotNullEquipmentSlot slot,@NullableItemStack item)
  Stores the ItemStack at the given equipment slot in the inventory.
  Parameters:
  slot - the slot to put the ItemStack
  item - the ItemStack to set
  See Also:
  setItem(int, ItemStack)
- getItem
  @NotNullItemStackgetItem(@NotNullEquipmentSlot slot)
  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
- 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
  See getExtraContents() 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 ifthe ItemStack is a helmet
  Parameters:
  helmet - The ItemStack to use as helmet
- setChestplate
  Put the given ItemStack into the chestplate slot. This does not checkif 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 theItemStack 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 theItemStack is a boots
  Parameters:
  boots - The ItemStack to use as boots
- getItemInMainHand
  Gets a copy of the item the player is currently holdingin 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 a copy of the item the player is currently holdingin 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 thespecific hand instead
  Gets a copy of the item the player is currently holding
  Returns:
  the currently held item
  See Also:
  getItemInMainHand(),getItemInOffHand()
- setItemInHand
  @DeprecatedvoidsetItemInHand(@NullableItemStack stack)
  Deprecated.
  players can duel wield now use the methods for thespecific hand instead
  Parameters:
  stack - The item to put into the player's hand
  See Also:
  setItemInMainHand(ItemStack),setItemInOffHand(ItemStack)
- getHeldItemSlot
  intgetHeldItemSlot()
  Returns:
  Held item slot number
- setHeldItemSlot
  voidsetHeldItemSlot(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 8inclusive
- 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.

JavaScript is disabled on your browser.

Class

Interface Inventory

All Superinterfaces:
Iterable<ItemStack>
All Known Subinterfaces:
AbstractHorseInventory, AnvilInventory, ArmoredHorseInventory, BeaconInventory, BrewerInventory, CraftingInventory, DoubleChestInventory, EnchantingInventory, FurnaceInventory, HorseInventory, LlamaInventory, MerchantInventory, PlayerInventory, SaddledHorseInventory
Interface to the various inventories. Behavior relating to Material.AIR is unspecified.

Method Summary

All MethodsInstance MethodsAbstract MethodsDeprecated Methods
Modifier and Type	Method	Description
`HashMap<Integer,ItemStack>`	`addItem(ItemStack... items)`
`HashMap<Integer,? extends ItemStack>`	`all(int materialId)`	Deprecated.
`HashMap<Integer,? extends ItemStack>`	`all(ItemStack item)`	Finds all slots in the inventory containing any ItemStacks with the given ItemStack.
`HashMap<Integer,? extends ItemStack>`	`all(Material material)`	Returns a HashMap with all slots and ItemStacks in the inventory with the given Material.
`void`	`clear()`
`void`	`clear(int index)`	Clears out a particular slot in the index.
`boolean`	`contains(int materialId)`	Deprecated.
`boolean`	`contains(int materialId, int amount)`	Deprecated.
`boolean`	`contains(ItemStack item)`	Checks if the inventory contains any ItemStacks matching the given ItemStack.
`boolean`	`contains(ItemStack item, int amount)`	Checks if the inventory contains at least the minimum amount specified of exactly matching ItemStacks.
`boolean`	`contains(Material material)`	Checks if the inventory contains any ItemStacks with the given material.
`boolean`	`contains(Material material, int amount)`	Checks if the inventory contains any ItemStacks with the given material, adding to at least the minimum amount specified.
`boolean`	`containsAtLeast(ItemStack item, int amount)`	Checks if the inventory contains ItemStacks matching the given ItemStack whose amounts sum to at least the minimum amount specified.
`int`	`first(int materialId)`	Deprecated.
`int`	`first(ItemStack item)`	Returns the first slot in the inventory containing an ItemStack with the given stack.
`int`	`first(Material material)`	Finds the first slot in the inventory containing an ItemStack with the given material
`int`	`firstEmpty()`
`ItemStack[]`	`getContents()`	Returns all ItemStacks from the inventory
`InventoryHolder`	`getHolder()`	Gets the block or entity belonging to the open inventory
`ItemStack`	`getItem(int index)`	Returns the ItemStack found in the slot at the given index
`Location`	`getLocation()`	Get the location of the block or entity which corresponds to this inventory.
`int`	`getMaxStackSize()`	Returns the maximum stack size for an ItemStack in this inventory.
`String`	`getName()`
`int`	`getSize()`	Returns the size of the inventory
`ItemStack[]`	`getStorageContents()`	Return the contents from the section of the inventory where items can reasonably be expected to be stored.
`String`	`getTitle()`
`InventoryType`	`getType()`	Returns what type of inventory this is.
`List<HumanEntity>`	`getViewers()`
`ListIterator<ItemStack>`	`iterator()`
`ListIterator<ItemStack>`	`iterator(int index)`	Returns an iterator starting at the given index.
`void`	`remove(int materialId)`	Deprecated.
`void`	`remove(ItemStack item)`	Removes all stacks in the inventory matching the given stack.
`void`	`remove(Material material)`	Removes all stacks in the inventory matching the given material.
`HashMap<Integer,ItemStack>`	`removeItem(ItemStack... items)`
`void`	`setContents(ItemStack[] items)`	Completely replaces the inventory's contents.
`void`	`setItem(int index, ItemStack item)`	Stores the ItemStack at the given index of the inventory.
`void`	`setMaxStackSize(int size)`	This method allows you to change the maximum stack size for an inventory.
`void`	`setStorageContents(ItemStack[] items)`

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