GUIs

Creating a GUI

You can create a Gui using the builder:

Java

Gui gui = Gui.chest()
        .title(Component.text("A GUI"))
        .rows(3)
        .build();

Kotlin

val gui = Gui.chest()
        .title(Component.text("A GUI"))
        .rows(3)
        .build()

A dropper or hopper can be created using their builders:

Java

Gui gui = Gui.dropper()
        .title(Component.text("A GUI"))
        .build();        

Gui gui = Gui.hopper()
        .title(Component.text("A GUI"))
        .build();

Kotlin

val gui = Gui.dropper()
        .title(Component.text("A GUI"))
        .build()

val gui = Gui.hopper()
        .title(Component.text("A GUI"))
        .build()

Adding Buttons

A Button can be added by chaining a button(Slot, Button) call:

Air is always represented by a null Button.

Java

Gui gui = Gui.chest()
        .button(Slot.of(1, 4), Button.of(ItemType.STONE))
        .build();

Kotlin

val gui = Gui.chest()
        .button(Slot(1, 4), Button.of(ItemType.STONE))
        .build()

The method may also be called on a built Gui:

Java

gui.button(Slot.of(1, 4), Button.of(ItemType.STONE));

Kotlin

gui.button(Slot(1, 4), Button.of(ItemType.STONE))

For more information relating to buttons, see Buttons.

Borders and Filling

border(Button) can be used to fill a border:

Java

Gui gui = Gui.chest()
        .border(Button.of(ItemType.GRAY_STAINED_GLASS_PANE)) // all sides
        .build();

Gui gui = Gui.chest()
        .border(Button.of(ItemType.GRAY_STAINED_GLASS_PANE), Border.BOTTOM)
        .build();

Kotlin

val gui = Gui.chest()
        .border(Button.of(ItemType.GRAY_STAINED_GLASS_PANE)) // all sides
        .build()

val gui = Gui.chest()
        .border(Button.of(ItemType.GRAY_STAINED_GLASS_PANE), Border.BOTTOM)
        .build()

To fill the entire GUI, fill(Button) can be used:

Java

Gui gui = Gui.chest()
        .fill(Button.of(ItemType.GRAY_STAINED_GLASS_PANE))
        .build();

Kotlin

val gui = Gui.chest()
        .fill(Button.of(ItemType.GRAY_STAINED_GLASS_PANE))
        .build()

Opening The GUI

To open a Gui, you need to first create a PaperVision:

Java

PaperVision vision = PaperVision.create(plugin);

Kotlin

val vision = PaperVision.create(plugin)

Then you can open it:

Java

Player player = ...;
vision.open(player, gui);

Kotlin

val player: Player = ..
vision.open(player, gui)