Class GuiButton

java.lang.Object

com.github.darksoulq.abyssallib.world.gui.element.GuiItem

com.github.darksoulq.abyssallib.world.gui.element.GuiButton

All Implemented Interfaces:

GuiElement

public class GuiButton
extends GuiItem

An interactive GUI element that executes an action when clicked.

This element displays an item but executes a provided consumer logic when a player interacts with it. It is the primary way to create clickable controls in a GUI. (Item may be null)

Constructor Summary

Constructors

Constructor	Description
GuiButton(org.bukkit.inventory.ItemStack item, Consumer<GuiClickContext> action)	Constructs a new GuiButton.

Method Summary

Modifier and Type	Method	Description
static GuiButton	of(org.bukkit.inventory.ItemStack item, Consumer<GuiClickContext> action)	Static factory method to create a GuiButton.
ActionResult	onClick(GuiClickContext ctx)	Executes the button action and cancels the inventory event.

Methods inherited from class GuiItem

of, onDrag, render

Methods inherited from class Object

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

Methods inherited from interface GuiElement

onClick, onDrag

Constructor Details

GuiButton

public GuiButton(org.bukkit.inventory.ItemStack item,
 Consumer<GuiClickContext> action)

Constructs a new GuiButton.

Parameters:

item - the button icon

action - the logic to run on click

Method Details

onClick

public ActionResult onClick(GuiClickContext ctx)

Executes the button action and cancels the inventory event.

Specified by:

onClick in interface GuiElement

Overrides:

onClick in class GuiItem

Parameters:

ctx - the click context

Returns:

ActionResult.CANCEL

of

public static GuiButton of(org.bukkit.inventory.ItemStack item,
 Consumer<GuiClickContext> action)

Static factory method to create a GuiButton.

Parameters:

item - the item icon

action - the click logic

Returns:

a new GuiButton instance