Package eu.xap3y.xagui

Class XaGui

Object

XaGui

public class XaGui
extends Object

Constructor Summary

Constructors

Constructor	Description
XaGui(@NotNull JavaPlugin plugin)

Method Summary

Modifier and Type	Method	Description
static void	addOpenMenu(UUID uuid, GuiMenuInterface menu)
void	closeAll()	Close all open menus
void	closeMenu(UUID uuid)	Register an open menu
GuiMenu	createMenu(String name, int rows)	Create a new menu
GuiMenu	createMenu(String name, int rows, int pages)	Create a new menu
Map<UUID,GuiMenuInterface>	getOpenMenus()	Get all open menus
static void	removeOpenMenu(UUID uuid)
void	setBorderItem(ItemStack item)	Set the item that will be used to fill the menu border
void	setButtonClickSound(Sound sound, float volume)	Set the sound that will be played when a player clicks a button
void	setClickSound(Sound sound)	Set the sound that will be played when a player clicks a button
void	setCloseButton(GuiButton item)	Set the item that will be used as the close button
void	setCloseButtonSound(Sound sound)	Set the sound that will be played when a player closes a menu
void	setNextPageButton(ItemStack item)	Set the item that will be used in paginator as next page button
void	setOnClose(GuiCloseInterface closeAction)	Set a handler invoked when any xagui inventory is closed.
void	setOnOpen(GuiOpenInterface openAction)	Set a handler invoked when any xagui inventory is opened.
void	setPreviousPageButton(ItemStack item)	Set the item that will be used in paginator as previous page button
void	setRedirectSound(Sound sound)	Set the sound that will be played when a player is redirected to another menu

Methods inherited from class Object

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

Constructor Details

XaGui

public XaGui(@NotNull
 @NotNull JavaPlugin plugin)

Method Details

createMenu

public GuiMenu createMenu(String name,
 int rows)

Create a new menu

Parameters:

name - The name of the menu

rows - The number of rows in the menu

Returns:

The created menu

See Also:

• GuiMenu

createMenu

public GuiMenu createMenu(String name,
 int rows,
 int pages)

Create a new menu

Parameters:

name - The name of the menu

rows - The number of rows in the menu

pages - The number of pages in the menu

Returns:

The created menu

See Also:

• GuiMenu

closeMenu

public void closeMenu(UUID uuid)

Register an open menu

Parameters:

uuid - The UUID of the player

closeAll

public void closeAll()

Close all open menus

setBorderItem

public void setBorderItem(ItemStack item)

Set the item that will be used to fill the menu border

Parameters:

item - The item that will fill the border

setOnClose

public void setOnClose(GuiCloseInterface closeAction)

Set a handler invoked when any xagui inventory is closed.

Parameters:

closeAction - close handler

setOnOpen

public void setOnOpen(GuiOpenInterface openAction)

Set a handler invoked when any xagui inventory is opened.

Parameters:

openAction - open handler

getOpenMenus

public Map<UUID,GuiMenuInterface> getOpenMenus()

Get all open menus

Returns:

A map of all open menus

setCloseButton

public void setCloseButton(GuiButton item)

Set the item that will be used as the close button

Parameters:

item - The item that will be used as the close button

setNextPageButton

public void setNextPageButton(ItemStack item)

Set the item that will be used in paginator as next page button

Parameters:

item - the item to use as next page button

setPreviousPageButton

public void setPreviousPageButton(ItemStack item)

Set the item that will be used in paginator as previous page button

Parameters:

item - the item to use as previous page button

setRedirectSound

public void setRedirectSound(Sound sound)

Set the sound that will be played when a player is redirected to another menu

Parameters:

sound - The sound that will be played

setCloseButtonSound

public void setCloseButtonSound(Sound sound)

Set the sound that will be played when a player closes a menu

Parameters:

sound - The sound that will be played

setButtonClickSound

public void setButtonClickSound(Sound sound,
 float volume)

Set the sound that will be played when a player clicks a button

Parameters:

sound - The sound that will be played

setClickSound

public void setClickSound(Sound sound)

Set the sound that will be played when a player clicks a button

Parameters:

sound - The sound that will be played

addOpenMenu

public static void addOpenMenu(UUID uuid,
 GuiMenuInterface menu)

removeOpenMenu

public static void removeOpenMenu(UUID uuid)