InventoryApi

Services.get("InventoryApi")

Overview

createItem(data) ⇒ ItemStack
constructInventory(type, title) ⇒ InventoryUI

API Reference

createItem()

Creates an ItemStack from a JavaScript object.

const item = inventoryApi.createItem({
    id: "minecraft:diamond",
    name: "§b§lExample Item",
    lore: [
        "§7This is an example",
        "§7Created via InventoryApi"
    ],
    amount: 1
})

Parameters:

• data (Object) Item configuration object:

Key	Type	Description
id	String	Minecraft item ID
name	String	Display name (supports color codes)
lore	String[]	Item lore
amount	Number (optional)	Item amount (default: 1)

Returns:

• ItemStack ⇒ org.bukkit.inventory.ItemStack

---

constructInventory()

Creates an interactive inventory UI.

const menu = inventoryApi.constructInventory("single", "§8Example Menu")

Parameters:

• type (String) "single" ⇒ Standard single chest inventory "double" ⇒ Standard double chest inventory

• title (String) Inventory title (supports color codes)

Returns:

• InventoryUI ⇒ Managed inventory interface

---

InventoryUI API

The object returned by constructInventory() exposes the following methods.

---

setSlot()

Sets an item in a specific slot.

menu.setSlot(0, item)

Parameters:

• slot (Number)

• item (ItemStack)

menu.setSlot(slot, null) to clear the slot

---

setTitle()

Set and update the inventory title.

menu.setTitle("New Title")

Parameters:

• title (String)

---

copy()

Creates a deep copy of the inventory UI.

const playerMenu = menu.copy()

Returns:

• InventoryUI

---

show()

Opens the inventory for a player.

menu.show(player)

Parameters:

• player (Player)

---

hide()

Closes the inventory for a player.

menu.hide(player)

Parameters:

• player (Player)

---

destroy()

Destroys the inventory and unregisters all listeners.

menu.destroy()

Always call destroy() when the inventory is no longer needed.

---

onLeftClick()

Registers a left-click handler.

menu.onLeftClick(function(player, slot, event) {
    event.setCancelled(true)
})

Returns: (function handler)

• player ⇒ Player

• slot ⇒ Number

• event ⇒ InventoryClickEvent

---

onRightClick()

Registers a right-click handler.

menu.onRightClick(function(player, slot, event) {
    event.setCancelled(true)
})

Returns: (function handler)

• player ⇒ Player

• slot ⇒ Number

• event ⇒ InventoryClickEvent

---

onItemPlaced()

Called when an item is placed into the inventory.

menu.onItemPlaced(function(player, slot, event) {
    event.setCancelled(true)
})

Returns: (function handler)

• player ⇒ Player

• slot ⇒ Number

• event ⇒ InventoryClickEvent

---

onClosed()

Called when the inventory is closed.

menu.onClosed(function(player, event) {
    menu.destroy()
})

Returns:

• player ⇒ Player

• event ⇒ InventoryCloseEvent

---

Example:

Example Menu with close button

const inventoryApi = Services.get("InventoryApi")
const template = inventoryApi.constructInventory("single", "§8Example Menu")
const closeItem = inventoryApi.createItem({
    id: "minecraft:barrier",
    name: "§cClose"
})

template.setSlot(8, closeItem)

addCommand("showMenu", {
    onCommand: function(player) {
        let menu = template.copy()

        menu.onLeftClick(function(_, slot, event) {
            event.setCancelled(true)
            if(slot === 8) {
                menu.hide(player)
                player.sendMessage("§cClosed custom Menu!")
            }
        })

        menu.onClosed(function() {
            menu.destroy()
        })

        menu.show(player)
    }
})