Scroll GUI

A Scroll GUI allows you to scroll through a list of items line by line. This can be done both vertically and horizontally.

Control Items

Before creating the Scroll GUI itself, you first need to create the Items for navigating it.

This would be an example for an Item that scrolls down:

KotlinJava

class ScrollDownItem : ScrollItem(1) {

    override fun getItemProvider(gui: ScrollGUI): ItemProvider {
        val builder = ItemBuilder(Material.GREEN_STAINED_GLASS_PANE)
        builder.setDisplayName("§7Scroll down")
        if (!gui.canScroll(1))
            builder.addLoreLines("§cYou can't scroll further down")
        return builder
    }

}

public class ScrollDownItem extends ScrollItem {

    public ScrollDownItem() {
        super(1);
    }

    @Override
    public ItemProvider getItemProvider(ScrollGUI gui) {
        ItemBuilder builder = new ItemBuilder(Material.GREEN_STAINED_GLASS_PANE);
        builder.setDisplayName("§7Scroll down");
        if (!gui.canScroll(1))
            builder.addLoreLines("§cYou can't scroll further down");

        return builder;
    }

}

And this Item scrolls up:

KotlinJava

class ScrollUpItem : ScrollItem(-1) {

    override fun getItemProvider(gui: ScrollGUI): ItemProvider {
        val builder = ItemBuilder(Material.RED_STAINED_GLASS_PANE)
        builder.setDisplayName("§7Scroll up")
        if (!gui.canScroll(-1))
            builder.addLoreLines("§cYou've reached the top")
        return builder
    }

}

    public class ScrollUpItem extends ScrollItem {

    public ScrollUpItem() {
        super(-1);
    }

    @Override
    public ItemProvider getItemProvider(ScrollGUI gui) {
        ItemBuilder builder = new ItemBuilder(Material.RED_STAINED_GLASS_PANE);
        builder.setDisplayName("§7Scroll up");
        if (!gui.canScroll(-1))
            builder.addLoreLines("§cYou've reached the top");

        return builder;
    }

}

Info

You also might want to register these Items as global ingredients.

Creating the GUI

Scroll Items

Now that we've created the ControlItems, let's make the actual GUI:

KotlinJava

val border = SimpleItem(ItemBuilder(Material.BLACK_STAINED_GLASS_PANE).setDisplayName("§r"))

// an example list of items to display
val items = Material.values()
    .filter { !it.isAir && it.isItem }
    .map { SimpleItem(ItemBuilder(it)) }

val gui = GUIBuilder(GUIType.SCROLL_ITEMS)
    .setStructure(
        "x x x x x x x x u",
        "x x x x x x x x #",
        "x x x x x x x x #",
        "x x x x x x x x #",
        "x x x x x x x x d")
    .addIngredient('x', Markers.ITEM_LIST_SLOT_VERTICAL)
    .addIngredient('#', border)
    .addIngredient('u', ScrollUpItem())
    .addIngredient('d', ScrollDownItem())
    .setItems(items)
    .build()

SimpleWindow(player, "InvUI", gui).show()

Item border = new SimpleItem(new ItemBuilder(Material.BLACK_STAINED_GLASS_PANE).setDisplayName("§r"));

// an example list of items to display
List<Item> items = Arrays.stream(Material.values())
    .filter(material -> !material.isAir() && material.isItem())
    .map(material -> new SimpleItem(new ItemBuilder(material)))
    .collect(Collectors.toList());

GUI gui = new GUIBuilder<>(GUIType.SCROLL_ITEMS)
    .setStructure(
        "x x x x x x x x u",
        "x x x x x x x x #",
        "x x x x x x x x #",
        "x x x x x x x x #",
        "x x x x x x x x d")
    .addIngredient('x', Markers.ITEM_LIST_SLOT_VERTICAL)
    .addIngredient('#', border)
    .addIngredient('u', new ScrollUpItem())
    .addIngredient('d', new ScrollDownItem())
    .setItems(items)
    .build();

new SimpleWindow(player, "InvUI", gui).show();

And this is how it looks in-game:

You can also change the scroll direction by using Markers.ITEM_LIST_SLOT_VERTICAL instead of Markers.ITEM_LIST_SLOT_HORIZONTAL. This would result in the gui scrolling from left to right:

Info

If you need even more control over the scroll direction, you'll need to set the itemListSlots yourself by manually constructing the SimpleScrollItemsGUI without the GUIBuilder.

Scroll GUIs

There is also an additional GUIType available, SCROLL_GUIS. It behaves in a very similar way to SCROLL_ITEMS, but instead of Items, it accepts GUIs. These Items of the GUIs are then displayed sequentially, so you'll want to make sure that the width of the GUIs matches the line size of your Scroll GUI.