Menu Framework

A dynamic and flexible library to handle complex menu hierarchies in bukkit.

JavaDoc

Compilation

We use maven to handle our dependencies.

• Install Maven 3
• Check out this repo and: mvn clean install package

Tutorial

Feel free to refer to Chester as example code.

Add the dependency (only for Maven users)

The following XML is for you to add to your pom.xml, it is needed for Maven to find the dependency.

<repositories>
    ...
    <!-- repository for NJay dependencies -->
    <repository>
        <id>njay-repo</id>
        <url>http://repo.njay.net/content/groups/public</url>
    </repository>
    ...
</repositories>

Now that Maven can get any depedency from Njay, you must add menu-framework do your dependencies list. Please check that the <version>1.0.9</version> is at the latest version of Njay to ensure you have all the latest bug fixes and features.

<dependencies>
    ...
    <!-- custom menu framework, available here: https://github.com/gcflames5/menu-framework -->
    <dependency>
        <groupId>net.njay</groupId>
        <artifactId>menu-framework</artifactId>
        <version>1.0.9</version>
    </dependency>
    ...
</dependencies>

If you're using an IDE, you may need to reimport your Maven dependencies in order for your IDE to detect the changes in your pom.xml.

Enable the Framework

MenuFramework.enable(new MenuRegistry(instance, TestMenu.class)); //Args: JavaPlugin, Class... menusToRegister

or, if you want to use a custom player manager with the framework:

MenuFramework.enable(new MenuRegistry(instance, TestMenu.class), instanceOfPlayerManager); //Args: JavaPlugin, Class... menusToRegister, extension of MenuPlayerManager

Creating a MenuItem

A menu item is a method that represents one box of the inventory, when that box is clicked, the method is invoked (the method must take a MenuPlayer as a parameter)

@MenuItem(slot = 5, item = @ItemStackAnnotation(material = Material.BEDROCK, name = "This is the item name"))
public void testItem1(MenuPlayer player) {
  player.getBukkit().sendMessage("This is a test message");
  player.setActiveMenu(new TestSubMenu(manager, null)); //This line changes the active menu to another menu, we'll cover that in more detail later
}

The @MenuItem annotation takes a slot (slot of the inventory) and an item which specifies the item that will reside in that slot

Creating a Menu class

@MenuInventory(slots = 18, name = "Sub Menu", filler = @ItemStackAnnotation(name = "", material = Material.BED), onClose = TestMenu.class)
@IgnoreSlots(slots = {1, 2, 3}, items = {
  @ItemStackAnnotation(material = Material.BED, name = "Test"),
  @ItemStackAnnotation(material = Material.APPLE, name = "#LeaveItToApple", lore = {"I", "LIKE", "PANTS"}),
  @ItemStackAnnotation(material = Material.GOLDEN_CARROT, name = "OllyCode", amount = 11)})
public static class TestSubMenu extends Menu {
  //We will add the menu items here later
}

The @MenuInventory annotation takes slots (number of inventory slots), a filler item (item that the unused slots are filled with), and an (optional) onClose parameter which says what class to open when the player exits the inventory

The @IgnoreSlots (optional) annotation shows which slots are allowed to be manipulated by the player, it takes an array of slots (the slots which can be manipulated, and an @ItemStackAnnotation which matches each of the slots

Combining MenuItem with a Menu class

@MenuInventory(slots = 18, name = "Sub Menu", filler = @ItemStackAnnotation(name = "", material = Material.BED), onClose = TestMenu.class)
@IgnoreSlots(slots = {1, 2, 3}, items = {
  @ItemStackAnnotation(material = Material.BED, name = "Test"),
  @ItemStackAnnotation(material = Material.APPLE, name = "#LeaveItToApple", lore = {"I", "LIKE", "PANTS"}),
  @ItemStackAnnotation(material = Material.GOLDEN_CARROT, name = "OllyCode", amount = 11)})
public static class TestSubMenu extends Menu {
    @MenuItem(slot = 5, item = @ItemStackAnnotation(material = Material.BEDROCK, name = "This is the item name"))
    public void testItem1(MenuPlayer player) {
      player.getBukkit().sendMessage("This is a test message");
    }
}

Simply add the method with the @MenuItem annotation into the class as a local method. (must be public and take MenuPlayer as an argument)

Setting the active menu of the player

MenuPlayer player = MenuFramework.getPlayerManager().getPlayer((Player) sender);
player.setActiveMenu(new TestMenu(player.getMenuManager(), null));

Using this method will make use of any custom player manager that you add

Add a preprocessor with @PreProcessor

A preprocessor is a method (or methods) that can modify the inventory upon creation (before it is shown to the player). This frees developers from the restrictions of the @ItemStackAnnotation

Requirements: The method must take an Inventory as a parameter

@PreProcessor
public void process(Inventory inv){
  //Modify the inventory
}

---

Feel free to contact me on bukkit gcflames5 if you are confused