README.md

ContainerMenu - A BDSX API

ContainerMenu is an API for BDSX that allows you to create fake interactive container menus !

---

Features

• Multiple containers support

• Item transactions detection

• container close detection

• possibility to dynamically change items

• custom container name !

• easy to use API

Available container types

• Chest

• Double chest

• Trapped chest

• Double trapped chest

• Hopper

• Dropper

• Dispenser

...and more to come !

Soon to be added

• Handling of non cancelled item transactions (possibility to take/place items)

• More container types

Installation

Installing as an npm module

run this command in your bdsx directory :

npm i @bdsx/containermenu

You can also use bdsx's plugin-manager

Installing as a standalone plugin

clone the repository in your plugins directory :

git clone https://github.com/Se7en-dev/ContainerMenu.git

Usage examples

You can simply create and display a fake chest this way :

const container = ContainerMenu.create(player, FakeContainerType.Chest);
container.sendToPlayer();

everything else is handled automatically !

You can add/delete items to the container this way :

// Sets the item in slot 0
container.setItem(0, ItemStack.constructWith("minecraft:diamond", 64));
// Adds the item to the first empty slot
container.addItem(ItemStack.constructWith("minecraft:diamond", 64));
// Set multiple items at once
container.setContents({
            5: ItemStack.constructWith("minecraft:gold_ingot", 1),
            7: ItemStack.constructWith("minecraft:iron_ingot", 1),
            9: ItemStack.constructWith("minecraft:emerald", 1),
        });
// Clears the item in slot 5
container.clearItem(5);
// Clears all items
container.clearContents();

no need to destruct the ItemStacks, it is done automatically after the container is closed

Other features :

// Set a custom name to the container
// (must be called before sending the container)
container.setCustomName("BDSX is awesome !");
// Closes the container client-side, and destructs it.
container.closeContainer();

Using callbacks :

container.onTransaction((action) => {
    // Do something here...
});

container.onContainerClose(() => {
    // Do something here...
});

nb: returning CANCEL for item transactions does not change anything for now. In the future, Items will be able to be placed and taken unless CANCEL is returned.

Simple examples

Sends a message when a diamond is clicked :

const container = ContainerMenu.create(actor, FakeContainerType.Chest);
        container.addItem(ItemStack.constructWith("minecraft:iron_ingot", 1));
        container.addItem(ItemStack.constructWith("minecraft:gold_ingot", 1));
        container.addItem(ItemStack.constructWith("minecraft:diamond", 1));
        container.sendToPlayer();
        container.onTransaction((action) => {
            if(action.type === ItemStackRequestActionType.Take && container.getItem(action.getSrc().slot)?.getName() === "minecraft:diamond") {
                container.closeContainer();
                actor.sendMessage("You have clicked the diamond!");
            }
        });

Sends a message when the player closes the container:

const container = ContainerMenu.create(actor, FakeContainerType.Chest);
        container.sendToPlayer();
        container.onContainerClose(() => {
            actor.sendMessage("Container closed !");
        });

Advanced usage

Item destruction :

When creating a fake container, if destructItems is set to true, items will be automatically destructed on container close. If set to false they won't, and need to be destructed manually (if needed to).

// The items will not be destructed when the container is closed
const container = ContainerMenu.create(actor, FakeContainerType.DoubleChest, false);

This parameter can be overriden when calling item-related methods :

// The old item at slot 0 will not be destructed (destructItems is set to false)
container.setItem(0, ItemStack.constructWith("minecraft:diamond", 1));
// The old item at slot 0 will be destructed (destructItems is overriden to true)
container.setItem(0, ItemStack.constructWith("minecraft:diamond", 1), true);

All items can be destructed at once :

// This is called automatically if destructItems is set to true
container.destructAllItems();

---

Credits

API base by @Rjlintkh

This plugin is licensed under GNU General Public License v3.0

Feel free to contribute :)