Package net.wesjd.anvilgui

Class AnvilGUI.Builder

java.lang.Object

net.wesjd.anvilgui.AnvilGUI.Builder

Enclosing class:

AnvilGUI

public static class AnvilGUI.Builder
extends Object

A builder class for an AnvilGUI object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AnvilGUI.Builder	allowConcurrentClickHandlerExecution()	By default, the async click handler will not run concurrently and instead wait for the previous CompletableFuture to finish before executing it again.
AnvilGUI.Builder	disableGeyserCompat()	Disables compatibility with Geyser software
AnvilGUI.Builder	interactableSlots(int... slots)	Permit the user to modify (take items in and out) the slot numbers provided.
AnvilGUI.Builder	itemLeft(org.bukkit.inventory.ItemStack item)	Sets the ItemStack to be put in the first slot
AnvilGUI.Builder	itemOutput(org.bukkit.inventory.ItemStack item)	Sets the ItemStack to be put in the output slot
AnvilGUI.Builder	itemRight(org.bukkit.inventory.ItemStack item)	Sets the ItemStack to be put in the second slot
AnvilGUI.Builder	jsonTitle(String json)	Sets the AnvilGUI title that is to be displayed to the user.
AnvilGUI.Builder	mainThreadExecutor(Executor executor)	Set a custom main server thread executor.
AnvilGUI.Builder	onClick(BiFunction<Integer,AnvilGUI.StateSnapshot,List<AnvilGUI.ResponseAction>> clickHandler)	Do an action when a slot is clicked in the inventory
AnvilGUI.Builder	onClickAsync(AnvilGUI.ClickHandler clickHandler)	Do an action when a slot is clicked in the inventory
AnvilGUI.Builder	onClose(Consumer<AnvilGUI.StateSnapshot> closeListener)	Listens for when the inventory is closed
AnvilGUI	open(org.bukkit.entity.Player player)	Creates the anvil GUI and opens it for the player
AnvilGUI.Builder	plugin(org.bukkit.plugin.Plugin plugin)	Sets the plugin for the AnvilGUI
AnvilGUI.Builder	preventClose()	Prevents the closing of the anvil GUI by the user
AnvilGUI.Builder	text(String text)	Sets the initial item-text that is displayed to the user.
AnvilGUI.Builder	title(String title)	Sets the AnvilGUI title that is to be displayed to the user.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

mainThreadExecutor

public AnvilGUI.Builder mainThreadExecutor(Executor executor)

Set a custom main server thread executor. Useful for plugins targeting Folia.

Parameters:

executor - The executor to run tasks on

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - when the executor is null

preventClose

public AnvilGUI.Builder preventClose()

Prevents the closing of the anvil GUI by the user

Returns:

The AnvilGUI.Builder instance

disableGeyserCompat

public AnvilGUI.Builder disableGeyserCompat()

Disables compatibility with Geyser software

interactableSlots

public AnvilGUI.Builder interactableSlots(int... slots)

Permit the user to modify (take items in and out) the slot numbers provided.

Parameters:

slots - A varags param for the slot numbers. You can avoid relying on magic constants by using the AnvilGUI.Slot class.

Returns:

The AnvilGUI.Builder instance

onClose

public AnvilGUI.Builder onClose(Consumer<AnvilGUI.StateSnapshot> closeListener)

Listens for when the inventory is closed

Parameters:

closeListener - An Consumer that is called when the anvil GUI is closed

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - when the closeListener is null

onClickAsync

public AnvilGUI.Builder onClickAsync(AnvilGUI.ClickHandler clickHandler)

Do an action when a slot is clicked in the inventory

The ClickHandler is only called when the previous execution of the ClickHandler has finished. To alter this behaviour use allowConcurrentClickHandlerExecution()

Parameters:

clickHandler - A AnvilGUI.ClickHandler that is called when the user clicks a slot. The Integer is the slot number corresponding to AnvilGUI.Slot, the AnvilGUI.StateSnapshot contains information about the current state of the anvil, and the response is a CompletableFuture that will eventually return a list of AnvilGUI.ResponseAction to execute in the order that they are supplied.

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - when the function supplied is null

allowConcurrentClickHandlerExecution

public AnvilGUI.Builder allowConcurrentClickHandlerExecution()

By default, the async click handler will not run concurrently and instead wait for the previous CompletableFuture to finish before executing it again.

If this trait is desired, it can be enabled by calling this method but may lead to inconsistent behaviour if not handled properly.

Returns:

The AnvilGUI.Builder instance

onClick

public AnvilGUI.Builder onClick(BiFunction<Integer,AnvilGUI.StateSnapshot,List<AnvilGUI.ResponseAction>> clickHandler)

Do an action when a slot is clicked in the inventory

Parameters:

clickHandler - A BiFunction that is called when the user clicks a slot. The Integer is the slot number corresponding to AnvilGUI.Slot, the AnvilGUI.StateSnapshot contains information about the current state of the anvil, and the response is a list of AnvilGUI.ResponseAction to execute in the order that they are supplied.

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - when the function supplied is null

plugin

public AnvilGUI.Builder plugin(org.bukkit.plugin.Plugin plugin)

Sets the plugin for the AnvilGUI

Parameters:

plugin - The Plugin this anvil GUI is associated with

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the plugin is null

text

public AnvilGUI.Builder text(String text)

Sets the initial item-text that is displayed to the user.

If the usage of Adventure Components is desired, you must create an item, set the displayname of it and put it into the AnvilGUI via itemLeft(ItemStack) manually.

Parameters:

text - The initial name of the item in the anvil

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the text is null

title

public AnvilGUI.Builder title(String title)

Sets the AnvilGUI title that is to be displayed to the user.
The provided title will be treated as literal text.

Parameters:

title - The title that is to be displayed to the user

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the title is null

jsonTitle

public AnvilGUI.Builder jsonTitle(String json)

Sets the AnvilGUI title that is to be displayed to the user.
The provided json will be parsed into rich chat components.

Parameters:

json - The title that is to be displayed to the user

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the title is null

See Also:

• ComponentSerializer.toString(BaseComponent)

itemLeft

public AnvilGUI.Builder itemLeft(org.bukkit.inventory.ItemStack item)

Sets the ItemStack to be put in the first slot

Parameters:

item - The ItemStack to be put in the first slot

Returns:

The AnvilGUI.Builder instance

Throws:

IllegalArgumentException - if the ItemStack is null

itemRight

public AnvilGUI.Builder itemRight(org.bukkit.inventory.ItemStack item)

Sets the ItemStack to be put in the second slot

Parameters:

item - The ItemStack to be put in the second slot

Returns:

The AnvilGUI.Builder instance

itemOutput

public AnvilGUI.Builder itemOutput(org.bukkit.inventory.ItemStack item)

Sets the ItemStack to be put in the output slot

Parameters:

item - The ItemStack to be put in the output slot

Returns:

The AnvilGUI.Builder instance

open

public AnvilGUI open(org.bukkit.entity.Player player)

Creates the anvil GUI and opens it for the player

Parameters:

player - The Player the anvil GUI should open for

Returns:

The AnvilGUI instance from this builder

Throws:

IllegalArgumentException - when the onClick function, plugin, or player is null