API - Getting started

Table of contents

  1. Installation
  2. Introduction
  3. First steps
  4. Accessing components
  5. Examples of component properties
    1. Setting custom click action
    2. Setting custom checks
    3. Setting other custom properties
  6. Inserting a new component

Visit Java Docs


The AdvancedGUI API is available as a Maven dependency. To start using the API, add these snippets to your pom.xml

  <name>Respark - Maven Repository</name>

also make sure to declare AdvancedGUI as a dependency in your plugin.yml

depend: [AdvancedGUI]


When working with the AdvancedGUI API the most common use-case is to extend the functionallity of a GUI Layout that was build with the web editor. Building the complete Layout from scratch by code, can be a lot of work so it is best practice to build as much as you can in the web editor and then use the API to modify that existing layout. In the following we will look at some ways you can do that.

First steps

The layout-file of the layout that you want to extend should be place into the layout/ folder - same as the regular layout files.

First you need to create a class, that will handle the extension logic:

public class MyLayoutExtension implements LayoutExtension {
    public static final String LAYOUT_NAME = "LAYOUT-NAME";

    public void onLayoutLoad(LayoutLoadEvent event) {
        if (layout.getName().equals(LAYOUT_NAME)) {
            // Your extension code goes here

the onLayoutLoad(...) method will be called each time a new layout is loaded (e.g. on server start or through /ag reload). So this is the best place to make your changes. As this method gets called for all layouts it is important to check for the layout name and only extend the layout you are interested in.

Add this line to your plugins onEnable(...) method to register the extension:

public void onEnable() {
    LayoutManager.getInstance().registerLayoutExtension(new MyLayoutExtension(), this);

This also registers the class as a regular spigot event-listener so you can listen to AdvancedGUI events like GuiInteractionExitEvent in your extension class.

Accessing components

Components are the heart of a layout, they define how the layout behaves and renders. Each layout has a template component-tree which is represented by a group-component at the top which contains a numer of child components which again can contain child components of their own. This component-tree gets copied once a new player starts an interaction, so each interaction has its own component-tree. In most cases changes should be made to the template component-tree. You can access the defaut component-tree through:

Layout layout = event.getLayout();
GroupComponent componentTree = layout.getTemplateComponentTree();

To access a specific component by its ID in the component-tree you simply call:

Component component = componentTree.locate("COMPONENT-ID");

or to get the specific component class returned (e.g. TextComponent):

TextComponent component = componentTree.locate("COMPONENT-ID", TextComponent.class);
// same as: TextComponent component = (TextComponent) componentTree.locate("COMPONENT-ID");

Examples of component properties

Depending on the type of component, there are several things you might want to do to intoduce custom logic

Setting custom click action

componentTree.locate("COMPONENT-ID").setClickAction((interaction, player, primaryTrigger) -> {
    Bukkit.broadcastMessage(player.getName()+" click the component!");

Important: To modify components in a click action (e.g. hide some component) you have to locate the component on the component-tree of the interaction not the template component-tree. As the template one got copied for the interaction and the player now sees his own component-tree.

componentTree.locate("COMPONENT-ID").setClickAction((interaction, player, primaryTrigger) -> {

So this would be wrong:

componentTree.locate("COMPONENT-ID").setClickAction((interaction, player, primaryTrigger) -> {

Setting custom checks

CheckComponent component = componentTree.locate("COMPONENT-ID", CheckComponent.class);
component.setCheck((context, player, primaryTrigger) -> player.isSleeping());

Setting other custom properties

Most components have their own properties, for example you could change the color of a rectangle component or set the active view of a view component

Color orange = new Color(242, 120, 75);
componentTree.locate("COMPONENT-ID", RectComponent.class).setColor(orange);
componentTree.locate("COMPONENT-ID", ViewComponent.class).setView("COMPONENT-ID-2");

Inserting a new component

Place a dummy component in the web editor at the position you want to have your own component. Then locate the dummy component and replace it with your own one:

DummyComponent dummyComponent = componentTree.locate("COMPONENT-ID", DummyComponent.class);

Where myComponent could by any component you would like: A basic component you can also place through the editor, components that are only available through the API (like ListComponent or HoverDetectorComponent) or even your very own component. To create your own component, just create a new class and extend Component or RectangularComponent if your component has an overall rectangular shape. A tutorial on how to create your own component is coming soon.