creating and using guis using lists

hello today i will show how to use lists to make functional guis. to start off you need to set up your main class, useful for kitpvp plugins and maybe hubs

Code:java

public class Main extends JavaPlugin {
    @Override
    public void onEnable() {
 
    }
    @Override    
     public void onDisable() {
        // im not using ondisable but you may
    }
}
 

now we make a new class called "MenuItem", this will hold our methods for click events and such

Code:java

public class MenuItem {
    private String message;
    private ItemStack item;
 
    public MenuItem(String message, ItemStack item) {
        this.message = message;
        this.item = item;
    }
 
    public ItemStack getItem() {
        return item;
    }
 
    public String getMessage() {
        return message;
    }
 
    public void setItem(ItemStack item) {
        this.item = item;
    }
 
    public void setMessage(String message) {
        this.message = message;
    }
}
 

the method 'getItem()' will return the instance of the classes item which in this case will be in our selector
the string 'getMessage()' will return a string which ill send to player on click, this can be method to teleport or give items
now create a list for storing these classes

Code:java

private List<MenuItem> items = new ArrayList<MenuItem>();

also add a getter for list

Code:java

    public List<MenuItem> getItems() {
        return items;
    }

now we create a listener to listen for click event i call it 'MenuListener' call it what you want

Code:java

public class MenuListener implements Listener {
    Main plugin;
 
    public MenuListener(Main instance) {
        this.plugin = instance;
    }
 
    public void show(Player p) {
 
    }
 
    @EventHandler
    public void onInventoryClick(InventoryClickEvent e) {
 
    }
}

now in the show method we must create inventory and add items to do this follow my lead

Code:java

Inventory inv = Bukkit.createInventory(null, 9, "Selector");

this creates inventory with name 'Selector'

Code:java

        for (MenuItem menuItem : plugin.getItems()) {
 
        }

we iterate through these items to add their itemstack to inv

Code:java

inv.addItem(menuItem.getItem());

now just open inventory for player

Code:java

p.openInventory(inv);

now we must do our click event. firstly make sure they don't click outside the inventory otherwise get errors

Code:java

        if (e.getSlotType() == SlotType.OUTSIDE)
            return;

now check if inventory name is correct

Code:java

        if (!e.getInventory().getName().equals("Selector"))
            return;

finally check if item has item meta and is not null

Code:java

        if (e.getCurrentItem() != null && e.getCurrentItem().hasItemMeta()) {
 
        }

now we will list through items and check if clicked item .equals() current item and if so send player message

Code:java

            for (MenuItem menuItem : plugin.getItems()) {
                if (e.getCurrentItem().equals(menuItem.getItem())) {
                    e.setCancelled(true);
                    ((Player) e.getWhoClicked()).sendMessage(menuItem.getMessage());
                    break;
                }
            }

were almost done, back to main class in onEnable method register your listener and add some items
final main class(after registering listener and adding items)

Code:java

public class Main extends JavaPlugin {
    private List<MenuItem> items = new ArrayList<MenuItem>();
    private MenuListener menu;
 
    public void onEnable() {
        menu = new MenuListener(this);
        Bukkit.getPluginManager().registerEvents(menu, this);
        items.add(new MenuItem(ChatColor.GREEN + "First message!", createItemStack(Material.IRON_INGOT, ChatColor.GOLD + "First")));
        items.add(new MenuItem(ChatColor.YELLOW + "Second message!", createItemStack(Material.IRON_INGOT, ChatColor.LIGHT_PURPLE + "Second")));
        items.add(new MenuItem(ChatColor.RED + "Last message!", createItemStack(Material.IRON_INGOT, "Last")));
    }
 
    public void onDisalbe() {
        // im not using ondisable but you may
    }
 
    public List<MenuItem> getItems() {
        return items;
    }
 
    private ItemStack createItemStack(Material material, String name) {
        ItemStack i = new ItemStack(material);
        ItemMeta im = i.getItemMeta();
        im.setDisplayName(name);
        i.setItemMeta(im);
        return i;
    }
 
    public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
        if (sender instanceof Player) {
            Player p = (Player) sender;
            if (command.getName().equalsIgnoreCase("gui")) {
                menu.show(p);
            }
        }
        return false;
    }
}

thanks for reading, hopefully you didnt tl;dr have fun making easy-to-add-to guis

 

Good one, seems legit!

 

Can I use the onDisalbe method? Or can you use @Override?

 

If the onDisable() method is empty and you do not plan on putting anything in there, then just leave out the onDisable() method.

Otherwise, you would correct the spelling and put @Override above it.