Package eu.xap3y.xagui

Class GuiMenu

Object

GuiMenu

All Implemented Interfaces:

GuiMenuInterface, InventoryHolder

public class GuiMenu
extends Object
implements InventoryHolder, GuiMenuInterface

Represents a paginated GUI menu.

Supports:

• Multiple pages with optional paginator controls
• Sticky slots rendered on every page
• Per-slot buttons with click listeners
• Per-inventory and self-inventory click policies (allow/blacklist)
• Open/close/click/page-switch callbacks

Implements InventoryHolder so it can be used directly as a Bukkit/Spigot inventory holder.

Field Summary

Fields

Modifier and Type	Field	Description
GuiClickInterface	onClickAction	Callback invoked on top-inventory clicks.
GuiOwnClickInterface	onClickActionOwn	Callback invoked on self-inventory clicks while viewing this GUI.
GuiCloseInterface	onCloseAction	Callback invoked on inventory close.
GuiOpenInterface	onOpenAction	Callback invoked on inventory open.
GuiPageSwitchInterface	onPageSwitchAction	Callback invoked after a page switch occurs.
final Map<Integer,Set<Integer>>	unlockedSlots	Tracks unlocked slots per page (page -> set of slot indices)

Constructor Summary

Constructors

Constructor	Description
GuiMenu(JavaPlugin plugin, String title, int rowsToSet, int pages)	Create a new GUI menu.

Method Summary

Modifier and Type	Method	Description
void	addCloseButton()	Add a default close button to page 0 (center of bottom row).
void	addCloseButton(int page, GuiButtonInterface button)	Add a close button (GuiButtonInterface) to a specific page at the default close-slot.
void	addCloseButton(int page, ItemStack button)	Add a close button (ItemStack) to a specific page at the default close-slot.
void	addCloseButtonAllPages()	Add a default close button to all pages (center of bottom row).
void	addPaginator()	Enable paginator controls using the globally configured XaGui next/previous items.
void	allowClickTypes(ClickType... types)	Add allowed click types for the top (GUI) inventory.
void	allowSelfInventoryClickTypes(ClickType... types)	Allow only the specified self-inventory click types.
void	blacklistClickTypes(ClickType... types)	Add blacklisted click types for the top (GUI) inventory.
void	callback()	Execute the configured callback action, if any.
void	clearAllSlots()	Clear all buttons from the current page.
void	clearAllSlots(int page)	Clear all buttons from a specific page.
void	clearSlot(int slot)	Clear the button at a slot in the current page.
void	clearSlot(int page, int slot)	Clear the button at a slot in a specific page.
void	close()	Close the GUI for the current viewer.
void	close(Player player)	Close the GUI for a player on the main server thread.
void	fillBorder()	Fill the border slots of all pages using the globally configured XaGui border filler.
void	fillBorder(int page, ItemStack item)	Fill the border slots of a specific page with an item.
void	fillBorder(ItemStack item)	Fill the border slots of the current page with an item.
void	fillBorder(Material material)	Fill the border slots of the current page with a material.
void	fillSlots(int page, GuiButtonInterface item, int... slots)	Fill the given slots on a specific page with a button.
void	fillSlots(int page, ItemStack item, int... slots)	Fill the given slots on a specific page with an ItemStack.
void	fillSlots(GuiButtonInterface item, int... slots)	Fill the given slots on the current page with a button instance.
void	fillSlots(ItemStack item, int... slots)	Fill the given slots on the current page with an ItemStack.
void	fillSlots(ItemStack item, Integer[] slots)	Fill the given slots on the current page with an ItemStack.
void	fillSlots(ItemStack item, List<Integer> slots)	Fill the given slots on the current page with an ItemStack.
void	fillSlots(ItemStack item, Set<Integer> slots)	Fill the given slots on the current page with an ItemStack.
ClickType[]	getAllowedClickTypes()	Get the allowed top-inventory click types.
ClickType[]	getAllowedSelfInventoryClickTypes()	Get the allowed self-inventory click types.
ClickType[]	getBlacklistedClickTypes()	Get the blacklisted top-inventory click types.
int	getCurrentPage()	Get the one-based current page number.
int	getCurrentPageIndex()	Get the zero-based index of the current page.
@NotNull Inventory	getInventory()	Get the current page's Inventory.
int	getMaxPages()	Get the maximum pages currently allocated.
String	getName()	Get the colored title used for the inventory (translates & codes).
Sound	getOpenSound()	Get the sound played when opening the GUI.
float	getOpenSoundVolume()	Get the volume of the sound played when opening the GUI.
JavaPlugin	getOwner()	Get the owning plugin instance.
int	getPages()	Get the number of allocated pages.
String	getRawName()	Get the uncolored, raw title value.
boolean	getSelfInventoryAccess()	Get whether the player's own inventory can be interacted with while this menu is open.
int	getSize()	Get the inventory size in slots.
GuiButtonInterface	getSlot(int slot)	Get the button at a slot in the current page.
GuiButtonInterface	getSlot(int page, int slot)	Get the button at a slot in a specific page.
boolean	isButtonLocked(int slot)	Check if a slot in the current page is locked.
void	lockButton(int slot)	Lock a slot on the current page, disallowing item pickup/move.
void	lockButton(int page, int slot)	Lock a slot on a specific page, disallowing item pickup/move.
void	open(int page, Player player)	Open the GUI to a player at a specific page.
void	open(Player player)	Open the GUI to a player at page 0.
void	setAllPageSlot(int slot, GuiButtonInterface button)	Set the same button to the given slot across all pages.
void	setAllPageSlot(int slot, ItemStack item)	Set the same ItemStack to the given slot across all pages.
void	setAllPageSlot(int slot, Material item)	Set the same Material to the given slot across all pages.
void	setCallback(Runnable callback)	Set a generic callback action that can be triggered via callback().
void	setName(String newName)	Set the (raw) name used as the inventory title.
void	setNextPageButton(ItemStack item)	Set the item used for the "next page" control.
void	setOnClick(GuiClickInterface onClick)	Set a handler invoked on clicks inside the top (GUI) inventory.
void	setOnClickOwn(GuiOwnClickInterface onClick)	Set a handler invoked on clicks in the player's own inventory while this GUI is open.
void	setOnClose(GuiCloseInterface closeAction)	Set a handler invoked when the inventory is closed.
void	setOnOpen(GuiOpenInterface openAction)	Set a handler invoked when the inventory is opened.
void	setOnPageSwitch(GuiPageSwitchInterface onPageSwitch)	Set a handler invoked after a page switch occurs.
void	setOpenSound(Sound sound, float volume)	Set an optional sound to play when opening the GUI.
void	setPageSwitchSound(Sound sound)	Set an optional sound to play when switching pages.
void	setPreviousPageButton(ItemStack item)	Set the item used for the "previous page" control.
void	setSelfInventoryAccess(boolean value)	Allow or disallow interaction with the player's own inventory while this menu is open.
void	setSlot(int page, int slot, GuiButtonInterface button)	Set a button at a slot in a specific page.
void	setSlot(int page, int slot, ItemStack button)	Set an ItemStack at a slot in a specific page.
void	setSlot(int page, int slot, Material button)	Set a Material at a slot in a specific page.
void	setSlot(int slot, GuiButtonInterface button)	Set a button at the given slot in the current page.
void	setSlot(int slot, ItemStack item)	Set an ItemStack at the given slot in the current page.
void	setSlot(int slot, Material item)	Set a Material at the given slot in the current page.
void	setSlotSafe(int page, int slot, GuiButtonInterface button)	Internal helper to write slot state and backing Inventory safely.
void	setTotalPages(int pages)	Reset total pages, clearing all current state and rebuilding internal mappings.
void	stickSlot(int slot)	Mark a slot as sticky so it is displayed on every page.
void	switchPage(int pageIndex, Player player)	Switch the currently viewed page for a player.
void	unlockButton(int slot)	Unlock a slot on the current page, allowing item pickup/move.
void	unlockButton(int page, int slot)	Unlock a slot on a specific page, allowing item pickup/move.
void	unStickSlot(int slot)	Unmark a previously sticky slot.
void	updateSlot(int page, int slot, ItemStack item)	Update the ItemStack in a slot on a specific page.
void	updateSlot(int page, int slot, Material item)	Update the Material in a slot on a specific page.
void	updateSlot(int slot, ItemStack item)	Update the ItemStack in a slot on the current page.
void	updateSlot(int slot, Material item)	Update the Material in a slot on the current page.

Methods inherited from class Object

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

Methods inherited from interface GuiMenuInterface

setOpenSound

Field Details

unlockedSlots

public final Map<Integer,Set<Integer>> unlockedSlots

Tracks unlocked slots per page (page -> set of slot indices)

onCloseAction

public GuiCloseInterface onCloseAction

Callback invoked on inventory close.

onOpenAction

public GuiOpenInterface onOpenAction

Callback invoked on inventory open.

onClickAction

public GuiClickInterface onClickAction

Callback invoked on top-inventory clicks.

onClickActionOwn

public GuiOwnClickInterface onClickActionOwn

Callback invoked on self-inventory clicks while viewing this GUI.

onPageSwitchAction

public GuiPageSwitchInterface onPageSwitchAction

Callback invoked after a page switch occurs.

Constructor Details

GuiMenu

public GuiMenu(JavaPlugin plugin,
 String title,
 int rowsToSet,
 int pages)

Create a new GUI menu.

Parameters:

plugin - the owning plugin

title - the menu title (supports color codes with &)

rowsToSet - number of rows (1-6 typical)

pages - initial number of pages to allocate

Method Details

getInventory

@NotNull
public @NotNull Inventory getInventory()

Get the current page's Inventory.

Specified by:

getInventory in interface InventoryHolder

Returns:

the currently active page inventory

close

public void close()

Close the GUI for the current viewer.

Specified by:

close in interface GuiMenuInterface

setOnOpen

public void setOnOpen(GuiOpenInterface openAction)

Set a handler invoked when the inventory is opened.

Specified by:

setOnOpen in interface GuiMenuInterface

Parameters:

openAction - open handler

setOnClose

public void setOnClose(GuiCloseInterface closeAction)

Set a handler invoked when the inventory is closed.

Specified by:

setOnClose in interface GuiMenuInterface

Parameters:

closeAction - close handler

setOnClick

public void setOnClick(GuiClickInterface onClick)

Set a handler invoked on clicks inside the top (GUI) inventory.

Specified by:

setOnClick in interface GuiMenuInterface

Parameters:

onClick - click handler

setOnClickOwn

public void setOnClickOwn(GuiOwnClickInterface onClick)

Set a handler invoked on clicks in the player's own inventory while this GUI is open.

Specified by:

setOnClickOwn in interface GuiMenuInterface

Parameters:

onClick - own-inventory click handler

setOnPageSwitch

public void setOnPageSwitch(GuiPageSwitchInterface onPageSwitch)

Set a handler invoked after a page switch occurs.

Specified by:

setOnPageSwitch in interface GuiMenuInterface

Parameters:

onPageSwitch - page switch handler

setName

public void setName(String newName)

Set the (raw) name used as the inventory title.

Specified by:

setName in interface GuiMenuInterface

Parameters:

newName - the new raw title

getName

public String getName()

Get the colored title used for the inventory (translates & codes).

Specified by:

getName in interface GuiMenuInterface

Returns:

colored title

getRawName

public String getRawName()

Get the uncolored, raw title value.

Specified by:

getRawName in interface GuiMenuInterface

Returns:

raw title

getSize

public int getSize()

Get the inventory size in slots.

Specified by:

getSize in interface GuiMenuInterface

Returns:

rows * 9

getPages

public int getPages()

Get the number of allocated pages.

Specified by:

getPages in interface GuiMenuInterface

Returns:

total pages mapping currently created

getCurrentPageIndex

public int getCurrentPageIndex()

Get the zero-based index of the current page.

Specified by:

getCurrentPageIndex in interface GuiMenuInterface

Returns:

current page index

getCurrentPage

public int getCurrentPage()

Get the one-based current page number.

Specified by:

getCurrentPage in interface GuiMenuInterface

Returns:

current page number

setSlot

public void setSlot(int slot,
 GuiButtonInterface button)

Set a button at the given slot in the current page.

Specified by:

setSlot in interface GuiMenuInterface

Parameters:

slot - slot index

button - button instance

setAllPageSlot

public void setAllPageSlot(int slot,
 GuiButtonInterface button)

Set the same button to the given slot across all pages.

Specified by:

setAllPageSlot in interface GuiMenuInterface

Parameters:

slot - slot index

button - button instance to reuse

setAllPageSlot

public void setAllPageSlot(int slot,
 ItemStack item)

Set the same ItemStack to the given slot across all pages.

Specified by:

setAllPageSlot in interface GuiMenuInterface

Parameters:

slot - slot index

item - itemstack to place

setAllPageSlot

public void setAllPageSlot(int slot,
 Material item)

Set the same Material to the given slot across all pages.

Specified by:

setAllPageSlot in interface GuiMenuInterface

Parameters:

slot - slot index

item - material to place (amount 1)

setSlot

public void setSlot(int slot,
 ItemStack item)

Set an ItemStack at the given slot in the current page.

Specified by:

setSlot in interface GuiMenuInterface

Parameters:

slot - slot index

item - itemstack to place

setSlot

public void setSlot(int slot,
 Material item)

Set a Material at the given slot in the current page.

Specified by:

setSlot in interface GuiMenuInterface

Parameters:

slot - slot index

item - material to place (amount 1)

setSlot

public void setSlot(int page,
 int slot,
 GuiButtonInterface button)

Set a button at a slot in a specific page.

Specified by:

setSlot in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

button - button to place

setSlotSafe

public void setSlotSafe(int page,
 int slot,
 GuiButtonInterface button)

Internal helper to write slot state and backing Inventory safely.

Parameters:

page - page index (0-based)

slot - slot index

button - button to place

setSlot

public void setSlot(int page,
 int slot,
 ItemStack button)

Set an ItemStack at a slot in a specific page.

Specified by:

setSlot in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

button - itemstack to place

setSlot

public void setSlot(int page,
 int slot,
 Material button)

Set a Material at a slot in a specific page.

Specified by:

setSlot in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

button - material to place (amount 1)

updateSlot

public void updateSlot(int slot,
 ItemStack item)

Update the ItemStack in a slot on the current page.

Specified by:

updateSlot in interface GuiMenuInterface

Parameters:

slot - slot index

item - new itemstack

updateSlot

public void updateSlot(int slot,
 Material item)

Update the Material in a slot on the current page.

Specified by:

updateSlot in interface GuiMenuInterface

Parameters:

slot - slot index

item - new material (amount 1)

updateSlot

public void updateSlot(int page,
 int slot,
 ItemStack item)

Update the ItemStack in a slot on a specific page.

Specified by:

updateSlot in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

item - new itemstack

updateSlot

public void updateSlot(int page,
 int slot,
 Material item)

Update the Material in a slot on a specific page.

Specified by:

updateSlot in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

item - new material (amount 1)

getSlot

public GuiButtonInterface getSlot(int slot)

Get the button at a slot in the current page.

Specified by:

getSlot in interface GuiMenuInterface

Parameters:

slot - slot index

Returns:

button or null

getSlot

public GuiButtonInterface getSlot(int page,
 int slot)

Get the button at a slot in a specific page.

Specified by:

getSlot in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

Returns:

button or null

clearSlot

public void clearSlot(int slot)

Clear the button at a slot in the current page.

Specified by:

clearSlot in interface GuiMenuInterface

Parameters:

slot - slot index

clearSlot

public void clearSlot(int page,
 int slot)

Clear the button at a slot in a specific page.

Specified by:

clearSlot in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

clearAllSlots

public void clearAllSlots()

Clear all buttons from the current page.

Specified by:

clearAllSlots in interface GuiMenuInterface

clearAllSlots

public void clearAllSlots(int page)

Clear all buttons from a specific page.

Specified by:

clearAllSlots in interface GuiMenuInterface

Parameters:

page - page index (0-based)

getOwner

public JavaPlugin getOwner()

Get the owning plugin instance.

Specified by:

getOwner in interface GuiMenuInterface

Returns:

owner plugin

unlockButton

public void unlockButton(int slot)

Unlock a slot on the current page, allowing item pickup/move.

Specified by:

unlockButton in interface GuiMenuInterface

Parameters:

slot - slot index

unlockButton

public void unlockButton(int page,
 int slot)

Unlock a slot on a specific page, allowing item pickup/move.

Specified by:

unlockButton in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

lockButton

public void lockButton(int slot)

Lock a slot on the current page, disallowing item pickup/move.

Specified by:

lockButton in interface GuiMenuInterface

Parameters:

slot - slot index

lockButton

public void lockButton(int page,
 int slot)

Lock a slot on a specific page, disallowing item pickup/move.

Specified by:

lockButton in interface GuiMenuInterface

Parameters:

page - page index (0-based)

slot - slot index

isButtonLocked

public boolean isButtonLocked(int slot)

Check if a slot in the current page is locked.

Specified by:

isButtonLocked in interface GuiMenuInterface

Parameters:

slot - slot index

Returns:

true if locked; false if unlocked

open

public void open(Player player)

Open the GUI to a player at page 0.

Specified by:

open in interface GuiMenuInterface

Parameters:

player - target player

open

public void open(int page,
 Player player)

Open the GUI to a player at a specific page.

Specified by:

open in interface GuiMenuInterface

Parameters:

page - page index (0-based)

player - target player

switchPage

public void switchPage(int pageIndex,
 Player player)

Switch the currently viewed page for a player. Adds paginator controls if configured and plays an optional page switch sound.

Specified by:

switchPage in interface GuiMenuInterface

Parameters:

pageIndex - target page index (0-based)

player - the player viewing the GUI

Throws:

PageOutOfBoundException - if the index is negative or exceeds max pages

getMaxPages

public int getMaxPages()

Get the maximum pages currently allocated.

Specified by:

getMaxPages in interface GuiMenuInterface

Returns:

total page count

stickSlot

public void stickSlot(int slot)

Mark a slot as sticky so it is displayed on every page.

Specified by:

stickSlot in interface GuiMenuInterface

Parameters:

slot - slot index

unStickSlot

public void unStickSlot(int slot)

Unmark a previously sticky slot.

Specified by:

unStickSlot in interface GuiMenuInterface

Parameters:

slot - slot index

close

public void close(Player player)

Close the GUI for a player on the main server thread.

Specified by:

close in interface GuiMenuInterface

Parameters:

player - the player to close for

fillSlots

public void fillSlots(ItemStack item,
 int... slots)

Fill the given slots on the current page with an ItemStack.

Specified by:

fillSlots in interface GuiMenuInterface

Parameters:

item - itemstack to place

slots - varargs of slot indices

fillSlots

public void fillSlots(ItemStack item,
 Integer[] slots)

Fill the given slots on the current page with an ItemStack.

Specified by:

fillSlots in interface GuiMenuInterface

Parameters:

item - itemstack to place

slots - array of slot indices

fillSlots

public void fillSlots(ItemStack item,
 Set<Integer> slots)

Fill the given slots on the current page with an ItemStack.

Specified by:

fillSlots in interface GuiMenuInterface

Parameters:

item - itemstack to place

slots - set of slot indices

fillSlots

public void fillSlots(ItemStack item,
 List<Integer> slots)

Fill the given slots on the current page with an ItemStack.

Specified by:

fillSlots in interface GuiMenuInterface

Parameters:

item - itemstack to place

slots - list of slot indices

fillSlots

public void fillSlots(GuiButtonInterface item,
 int... slots)

Fill the given slots on the current page with a button instance.

Specified by:

fillSlots in interface GuiMenuInterface

Parameters:

item - button instance

slots - varargs of slot indices

fillSlots

public void fillSlots(int page,
 ItemStack item,
 int... slots)

Fill the given slots on a specific page with an ItemStack.

Specified by:

fillSlots in interface GuiMenuInterface

Parameters:

page - page index (0-based)

item - itemstack to place

slots - varargs of slot indices

fillSlots

public void fillSlots(int page,
 GuiButtonInterface item,
 int... slots)

Fill the given slots on a specific page with a button.

Specified by:

fillSlots in interface GuiMenuInterface

Parameters:

page - page index (0-based)

item - button instance

slots - varargs of slot indices

addCloseButton

public void addCloseButton()

Add a default close button to page 0 (center of bottom row).

Specified by:

addCloseButton in interface GuiMenuInterface

addCloseButtonAllPages

public void addCloseButtonAllPages()

Add a default close button to all pages (center of bottom row).

Specified by:

addCloseButtonAllPages in interface GuiMenuInterface

addCloseButton

public void addCloseButton(int page,
 ItemStack button)

Add a close button (ItemStack) to a specific page at the default close-slot.

Specified by:

addCloseButton in interface GuiMenuInterface

Parameters:

page - page index (0-based)

button - itemstack to use

addCloseButton

public void addCloseButton(int page,
 GuiButtonInterface button)

Add a close button (GuiButtonInterface) to a specific page at the default close-slot.

Specified by:

addCloseButton in interface GuiMenuInterface

Parameters:

page - page index (0-based)

button - button instance to use

addPaginator

public void addPaginator()

Enable paginator controls using the globally configured XaGui next/previous items.

Specified by:

addPaginator in interface GuiMenuInterface

setNextPageButton

public void setNextPageButton(ItemStack item)

Set the item used for the "next page" control.

Specified by:

setNextPageButton in interface GuiMenuInterface

Parameters:

item - itemstack for next page

setPreviousPageButton

public void setPreviousPageButton(ItemStack item)

Set the item used for the "previous page" control.

Specified by:

setPreviousPageButton in interface GuiMenuInterface

Parameters:

item - itemstack for previous page

setPageSwitchSound

public void setPageSwitchSound(Sound sound)

Set an optional sound to play when switching pages.

Specified by:

setPageSwitchSound in interface GuiMenuInterface

Parameters:

sound - page switch sound (nullable to disable)

setOpenSound

public void setOpenSound(Sound sound,
 float volume)

Set an optional sound to play when opening the GUI.

Specified by:

setOpenSound in interface GuiMenuInterface

Parameters:

sound - open sound (nullable to disable)

volume - sound volume

getOpenSound

public Sound getOpenSound()

Get the sound played when opening the GUI.

Specified by:

getOpenSound in interface GuiMenuInterface

Returns:

open sound

getOpenSoundVolume

public float getOpenSoundVolume()

Get the volume of the sound played when opening the GUI.

Specified by:

getOpenSoundVolume in interface GuiMenuInterface

Returns:

open sound volume

fillBorder

public void fillBorder()

Fill the border slots of all pages using the globally configured XaGui border filler.

Specified by:

fillBorder in interface GuiMenuInterface

fillBorder

public void fillBorder(int page,
 ItemStack item)

Fill the border slots of a specific page with an item.

Specified by:

fillBorder in interface GuiMenuInterface

Parameters:

page - page index (0-based)

item - itemstack to place in border

fillBorder

public void fillBorder(ItemStack item)

Fill the border slots of the current page with an item.

Specified by:

fillBorder in interface GuiMenuInterface

Parameters:

item - itemstack to place in border

fillBorder

public void fillBorder(Material material)

Fill the border slots of the current page with a material.

Specified by:

fillBorder in interface GuiMenuInterface

Parameters:

material - material to place (amount 1)

setSelfInventoryAccess

public void setSelfInventoryAccess(boolean value)

Allow or disallow interaction with the player's own inventory while this menu is open.

Specified by:

setSelfInventoryAccess in interface GuiMenuInterface

Parameters:

value - true to allow; false to deny

getSelfInventoryAccess

public boolean getSelfInventoryAccess()

Get whether the player's own inventory can be interacted with while this menu is open.

Specified by:

getSelfInventoryAccess in interface GuiMenuInterface

Returns:

true if allowed; false otherwise

allowSelfInventoryClickTypes

public void allowSelfInventoryClickTypes(ClickType... types)

Allow only the specified self-inventory click types. If any types are set here, only those will be allowed for the player's own inventory.

Specified by:

allowSelfInventoryClickTypes in interface GuiMenuInterface

Parameters:

types - allowed self-inventory click types

getAllowedSelfInventoryClickTypes

public ClickType[] getAllowedSelfInventoryClickTypes()

Get the allowed self-inventory click types.

Specified by:

getAllowedSelfInventoryClickTypes in interface GuiMenuInterface

Returns:

array of allowed click types (empty means not restricted here)

allowClickTypes

public void allowClickTypes(ClickType... types)

Add allowed click types for the top (GUI) inventory. If any are configured, a click not present here will be denied.

Specified by:

allowClickTypes in interface GuiMenuInterface

Parameters:

types - allowed top-inventory click types

blacklistClickTypes

public void blacklistClickTypes(ClickType... types)

Add blacklisted click types for the top (GUI) inventory. If configured, any click present here will be denied.

Specified by:

blacklistClickTypes in interface GuiMenuInterface

Parameters:

types - blacklisted top-inventory click types

getAllowedClickTypes

public ClickType[] getAllowedClickTypes()

Get the allowed top-inventory click types.

Specified by:

getAllowedClickTypes in interface GuiMenuInterface

Returns:

array of allowed click types (empty means not restricted here)

getBlacklistedClickTypes

public ClickType[] getBlacklistedClickTypes()

Get the blacklisted top-inventory click types.

Specified by:

getBlacklistedClickTypes in interface GuiMenuInterface

Returns:

array of blacklisted click types

callback

public void callback()

Execute the configured callback action, if any.

Specified by:

callback in interface GuiMenuInterface

setCallback

public void setCallback(Runnable callback)

Set a generic callback action that can be triggered via callback().

Specified by:

setCallback in interface GuiMenuInterface

Parameters:

callback - runnable to execute

setTotalPages

public void setTotalPages(int pages)

Reset total pages, clearing all current state and rebuilding internal mappings.

Specified by:

setTotalPages in interface GuiMenuInterface

Parameters:

pages - new total page count