Class ViewBuilder

java.lang.Object

me.agent.vgui.api.ViewBuilder

public final class ViewBuilder
extends Object

Fluent builder for views. It builds complete menus without subclassing View. Obtain via VGui.chest(int) or VGui.view(ViewType).

The produced View is immutable and reusable: open it for any number of players; per-player state lives in each player's ViewContents.

Method Summary

Modifier and Type	Method	Description
View	build()	Builds the immutable, reusable view.
ViewBuilder	cancelClientTransactions(boolean cancel)	See View.cancelClientTransactions().
ViewBuilder	clickCooldown(Duration cooldown)	See View.clickCooldownMillis().
ViewBuilder	item(int row, int column, ViewItem item)	Places an item at a row/column position (applied after the layout).
ViewBuilder	item(int slot, ViewItem item)	Places an item at a flat slot index (applied after the layout).
ViewBuilder	layout(String... rows)	Sets a character-mask layout.
ViewBuilder	map(char character, ViewItem item)	Maps a layout character to an item ('.' and ' ' stay empty).
ViewBuilder	onAnvilInput(BiConsumer<String, ViewContents> onAnvilInput)	Runs on anvil rename input (only for ViewType.ANVIL views).
ViewBuilder	onClick(Consumer<ClickContext> onClick)	Runs for every click (after any per-item handler).
ViewBuilder	onClose(CloseHandler onClose)	Runs when the view closes.
ViewBuilder	onOpen(Consumer<ViewContents> onOpen)	Runs after the layout and items are applied when the view opens for a player.
ViewBuilder	title(net.kyori.adventure.text.Component title)	Sets the window title.
ViewBuilder	updateEvery(Duration interval, Consumer<ViewContents> task)	Registers a repeating update task started when the view opens and cancelled when it closes.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

title

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

Sets the window title.

layout

public ViewBuilder layout(String... rows)

Sets a character-mask layout. Row count and width must match the view type (e.g. 9 characters per row for chests). Map characters with map(char, ViewItem).

map

public ViewBuilder map(char character,
 ViewItem item)

Maps a layout character to an item ('.' and ' ' stay empty).

item

public ViewBuilder item(int slot,
 ViewItem item)

Places an item at a flat slot index (applied after the layout).

item

public ViewBuilder item(int row,
 int column,
 ViewItem item)

Places an item at a row/column position (applied after the layout).

onOpen

public ViewBuilder onOpen(Consumer<ViewContents> onOpen)

Runs after the layout and items are applied when the view opens for a player.

onClick

public ViewBuilder onClick(Consumer<ClickContext> onClick)

Runs for every click (after any per-item handler).

onClose

public ViewBuilder onClose(CloseHandler onClose)

Runs when the view closes.

onAnvilInput

public ViewBuilder onAnvilInput(BiConsumer<String, ViewContents> onAnvilInput)

Runs on anvil rename input (only for ViewType.ANVIL views).

updateEvery

public ViewBuilder updateEvery(Duration interval,
 Consumer<ViewContents> task)

Registers a repeating update task started when the view opens and cancelled when it closes. This is useful for animations and live data.

cancelClientTransactions

public ViewBuilder cancelClientTransactions(boolean cancel)

See View.cancelClientTransactions(). Default true.

clickCooldown

public ViewBuilder clickCooldown(Duration cooldown)

See View.clickCooldownMillis(). Default: disabled.

build

public View build()

Builds the immutable, reusable view.