Overview Minestom provides a comprehensive inventory system for managing items in containers, player inventories, and custom GUIs.
Inventory Represents an inventory that can be viewed by multiple players.
Creating Inventories Chest Inventory
Custom GUI
Inventory chest = new Inventory ( InventoryType . CHEST_3_ROW , "My Chest" ); // Set items chest . setItemStack ( 0 , ItemStack . of ( Material . DIAMOND )); chest . setItemStack ( 1 , ItemStack . of ( Material . EMERALD , 64 )); // Open for player player . openInventory (chest);
Constructor Creates a new inventory The type of inventory (determines size and appearance)
The inventory title displayed to players
Item Management Sets an ItemStack at the specified slot Automatically sends updates to all viewers Gets the ItemStack at the specified slot Adds an ItemStack to the inventory Returns true if the item was successfully added Takes an ItemStack from the inventory Replaces an ItemStack using an operator Function to transform the item
Clears all items from the inventory and updates viewers
Gets a copy of all items in the inventory
Copies items from an array into this inventory Array of items (must match inventory size)
Viewers Adds a viewer (does NOT open the inventory) The player to add as viewer
Use player.openInventory(inventory) to actually open it Removes a viewer (does NOT close the inventory) Use player.closeInventory() to close it Gets all players currently viewing this inventory
Refreshes the inventory for all viewers
Properties Changes the inventory title Re-opens the inventory for all viewers Gets the total size of the inventory (number of slots)
Gets the window ID used by the client to identify this inventory
Click Handling Sets a custom click processor for handling inventory clicks Adds a click condition/handler PlayerInventory Represents a player’s inventory (extends AbstractInventory).
Accessing Player Inventory Player player = /* get player */ ; PlayerInventory inventory = player . getInventory (); // Main hand ItemStack mainHand = inventory . getItemInMainHand (); inventory . setItemInMainHand ( ItemStack . of ( Material . DIAMOND_SWORD )); // Armor itemStack helmet = inventory . getHelmet (); inventory . setHelmet ( ItemStack . of ( Material . DIAMOND_HELMET ));
Equipment Methods Gets equipment in a specific slot The equipment slot (MAIN_HAND, OFF_HAND, HELMET, etc.)
The player’s current held slot
Sets equipment in a specific slot Cursor Item Gets the item in the player’s cursor (what they’re dragging)
Constants PlayerInventory.INVENTORY_SIZE
Total inventory size (46 slots)
PlayerInventory.INNER_INVENTORY_SIZE
Main inventory size excluding armor/offhand (36 slots)
InventoryType Enum representing different inventory types.
Available Types And more: BLAST_FURNACE, SMOKER, LOOM, GRINDSTONE, SMITHING, CARTOGRAPHY, STONE_CUTTER, etc.
Methods Gets the number of slots in this inventory type
Gets the protocol window type ID
Usage Examples Inventory menu = new Inventory ( InventoryType . CHEST_3_ROW , "Choose an option" ); // Set border ItemStack border = ItemStack . of ( Material . BLACK_STAINED_GLASS_PANE ); for ( int i : new int []{ 0 , 1 , 2 , 3 , 5 , 6 , 7 , 8 , 9 , 17 , 18 , 19 , 20 , 21 , 23 , 24 , 25 , 26 }) { menu . setItemStack (i, border); } // Add options menu . setItemStack ( 11 , ItemStack . builder ( Material . DIAMOND_SWORD ) . displayName ( Component . text ( "PvP Arena" )) . build ()); menu . setItemStack ( 13 , ItemStack . builder ( Material . GRASS_BLOCK ) . displayName ( Component . text ( "Build World" )) . build ()); menu . setItemStack ( 15 , ItemStack . builder ( Material . ENDER_PEARL ) . displayName ( Component . text ( "Hub" )) . build ()); // Handle clicks menu . addInventoryCondition ((player, slot, clickType, result) -> { result . setCancel ( true ); // Prevent taking items switch (slot) { case 11 -> player . sendMessage ( "Teleporting to PvP..." ); case 13 -> player . sendMessage ( "Teleporting to Build..." ); case 15 -> player . sendMessage ( "Teleporting to Hub..." ); } player . closeInventory (); }); player . openInventory (menu);
Paginated Inventory public class PagedInventory { private final List < ItemStack > items ; private int currentPage = 0 ; public Inventory createPage ( int page ) { Inventory inv = new Inventory ( InventoryType . CHEST_6_ROW , "Page " + (page + 1 )); int startIdx = page * 45 ; int endIdx = Math . min (startIdx + 45 , items . size ()); for ( int i = startIdx; i < endIdx; i ++ ) { inv . setItemStack (i - startIdx, items . get (i)); } // Navigation if (page > 0 ) { inv . setItemStack ( 45 , ItemStack . of ( Material . ARROW ) . withDisplayName ( Component . text ( "Previous" ))); } if (endIdx < items . size ()) { inv . setItemStack ( 53 , ItemStack . of ( Material . ARROW ) . withDisplayName ( Component . text ( "Next" ))); } return inv; } }
Event Listening Inventory shop = new Inventory ( InventoryType . CHEST_3_ROW , "Shop" ); // Listen to the inventory's event node shop . eventNode (). addListener ( InventoryPreClickEvent . class , event -> { event . setCancelled ( true ); // Cancel all clicks Player player = event . getPlayer (); int slot = event . getSlot (); // Handle purchase logic }); // Or use global event handler MinecraftServer . getGlobalEventHandler () . addListener ( InventoryPreClickEvent . class , event -> { if ( event . getInventory () == shop) { // Handle shop clicks } });
Use player.openInventory(inventory) to open and player.closeInventory() to close inventories. Direct viewer management with addViewer/removeViewer does not send open/close packets.
