Configuration Guide

This guide covers all configuration options available. Use these options inside onInit(...) to define how a view behaves, looks, and interacts with players.

Tip

If you need to adjust the configuration per player—for example, changing the title only for a specific player—you can use modifyConfig inside onOpen. All configuration options available in onInit are also supported on a per-player basis within onOpen.

@Override
public void onOpen(OpenContext open) {
    open.modifyConfig().title(String.format(
        "Hi, %s", open.getPlayer().getName()
    ));
}

Inventory Appearance & Structure

Options that define how the inventory container itself is created.

title(String)

Sets the initial title of the inventory.

@Override
public void onInit(ViewConfigBuilder config) {
    config.title("Write something");
}

title(net.kyori.adventure.text.Component)

Sets the initial title using an Adventure Text Component.

Note

To use Adventure components as titles, make sure the inventory-framework-platform-paper module is on your classpath. See the Installation guide for details.

@Override
public void onInit(ViewConfigBuilder config) {
    config.title(Component.text("Write something")
                    .color(NamedTextColor.BLUE));
}

size(int)

Sets the size of the inventory.

@Override
public void onInit(ViewConfigBuilder config) {
    config.size(4); // rows
    config.size(45); // full size
}

maxSize()

Sets the size of the inventory to the maximum possible,
based on the inventory type.

@Override
public void onInit(ViewConfigBuilder config) {
    config.maxSize();
}

• type(ViewType)

Affects Player Interaction

• cancelOnClick()
• cancelOnDrag()
• cancelOnDrop()
• cancelOnPickup()
• interactionDelay(Duration)

Structure Modification

• layout(String[])

Internal Behavior

• transitiveInitialData(boolean)

Extension to External Features

• scheduleUpdate(Duration)