GramDev1/AmpMenus

An inventory menu library for Bukkit

AmpMenus (Forked to work with newer versions)

An object-oriented approach to handling Inventory Menus/GUIs in Bukkit.

AmpMenus is intended for advanced use cases such as the following examples:

Attribute Allocation Menu

• Displays the player's current attribute amounts on the attribute items
• Increase and decrease the points to add by clicking the wool above/below the attribute items
• Display the increase points item as green wool if the player has enough attribute points to increase the attribute
• Display the decrease points item as red wool if the player has actually increased the attribute
• Confirm or cancel point selection

Capture The Flag Shop

• Display the next available tier of different classes and perks

Because the items in these menus behave differently depending on the player and certain data or conditions, they would not be possible with a traditional plugin such as http://dev.bukkit.org/bukkit-plugins/chest-commands/ and would be impractical to create with a simpler utility such as https://forums.bukkit.org/threads/icon-menu.108342/

For Developers

If you're using Maven to manage project dependencies, simply include the following in your pom.xml:

<repository>
  <id>greatman-repo</id>
  <url>http://repo.greatmancode.com/content/groups/public/</url>
</repository>

<dependency>
  <groupId>ninja.amp</groupId>
  <artifactId>ampmenus</artifactId>
  <version>1.4-SNAPSHOT</version>
  <scope>compile</scope>
</dependency>

Basic Usage:

// Important - Register the MenuListener on enable or before players are able to open them
MenuListener.getInstance().register(plugin);

// Create an ItemMenu instance - you only need one of these. Don't create one every time you need it...
ItemMenu menu = new ItemMenu("Shop", Size.TWO_LINE, plugin);

// Adding items to your ItemMenu
menu.setItem(17, new CloseItem());

// Opening the menu for a Player
menu.open(player);

Advanced Usage:

public class ShopMenu extends ItemMenu {
    public ShopMenu(JavaPlugin plugin) {
        super("Shop", Size.TWO_LINE, plugin);

        // Adding items to your ItemMenu
        setItem(17, new CloseItem());
    }

    // Useful in case you only want the back item to appear if the menu has a parent
    @Override
    public void setParent(ItemMenu parent) {
        super.setParent(parent);
        if (parent != null) {
            setItem(16, new BackItem());
        }
    }
}

// Setting parent menus so that the BackItem knows where to go
ItemMenu subMenu = new ItemMenu("Vote Perks", Size.FIVE_LINE, plugin);
subMenu.setParent(mainMenu);
OR
ItemMenu subMenu = new ItemMenu("Vote Perks", Size.FIVE_LINE, plugin, mainMenu);

Creating Menu Items:

/**
* A MenuItem that makes the player perform the "kill" command
*/
public class SuicideItem extends MenuItem {
    private static final String DISPLAY_NAME = ChatColor.BLUE + "Click for OP!";
    private static final ItemStack ICON = new ItemStack(Material.DIAMOND);

    public SuicideItem() {
        super(DISPLAY_NAME, ICON);
    }

    // This method controls what happens when the MenuItem is clicked
    @Override
    public void onItemClick(ItemClickEvent event) {
        event.getPlayer().performCommand("kill");
    }

    // This method lets you modify the ItemStack before it is displayed, based on the player opening the menu
    @Override
    public ItemStack getFinalIcon(Player player) {
        ItemStack finalIcon = super.getFinalIcon(player);
        if (player.hasPermission("you.cant.fool.me")) {
            finalIcon.setType(Material.LEASH);
            ItemMeta meta = finalIcon.getItemMeta();
            meta.setDisplayName(ChatColor.DARK_RED + "Suicide");
            finalIcon.setItemMeta(meta);
        }
        return finalIcon;
    }
}

Compilation

AmpMenus uses Maven to handle its dependencies.

• Download and install Maven 3
• Checkout this repo and run: mvn clean install

The License

AmpMenus is licensed under the GNU Lesser General Public License Version 3

Contributing

Guidelines:

• All new files must include the license header. This can be done automatically with Maven by running mvn clean install.
• Generally follow the Oracle code conventions and the current style.
• Use four spaces for indentation, not tabs.
• No trailing whitespace (spaces/tabs on new lines and end of lines).
• 200 column limit for readability.