me.mattstudios.mfgui.gui.guis

Class BaseGui

java.lang.Object

me.mattstudios.mfgui.gui.guis.BaseGui

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

Direct Known Subclasses:

Gui, PaginatedGui, PersistentGui

public abstract class BaseGui
extends Object
implements org.bukkit.inventory.InventoryHolder

Base class that every GUI extends Contains all the basics for the GUI to work Main and simplest implementation of this is Gui

Constructor Summary

Constructors

Constructor and Description
BaseGui(@NotNull GuiType guiType, @NotNull String title) Alternative constructor that takes GuiType instead of rows number
BaseGui(int rows, @NotNull String title) Main constructor that takes rows

Method Summary

Modifier and Type	Method and Description
void	addItem(GuiItem... items) Adds GuiItems to the GUI without specific slot It'll set the item to the next empty slot available
void	addSlotAction(int slot, @Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> slotAction) Adds a GuiAction for when clicking on a specific slot See InventoryClickEvent
void	addSlotAction(int row, int col, @Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> slotAction) Alternative method for addSlotAction(int, GuiAction) to add a GuiAction to a specific slot using ROWS and COLUMNS instead of slots See InventoryClickEvent
void	close(@NotNull org.bukkit.entity.HumanEntity player) Closes the GUI with a 2s delay (to prevent items from being taken from the Inventory)
@NotNull GuiFiller	getFiller() Gets the GuiFiller that it's used for filling up the GUI in specific ways
@Nullable GuiItem	getGuiItem(int slot) Gets a specific GuiItem on the slot
Map<Integer,GuiItem>	getGuiItems() Gets an immutable Map with all the GUI items
@NotNull org.bukkit.inventory.Inventory	getInventory() Gets the main Inventory of this GUI
int	getRows() Gets the amount of rows
boolean	isUpdating() Checks whether or not the GUI is updating
void	open(@NotNull org.bukkit.entity.HumanEntity player) Opens the GUI for a HumanEntity
void	setCloseGuiAction(@Nullable GuiAction<org.bukkit.event.inventory.InventoryCloseEvent> closeGuiAction) Sets the GuiAction to run once the inventory is closed See InventoryCloseEvent
void	setDefaultClickAction(@Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultClickAction) Sets the GuiAction of a default click on any item See InventoryClickEvent
void	setDefaultTopClickAction(@Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultTopClickAction) Sets the GuiAction of a default click on any item on the top part of the GUI Top inventory being for example chests etc, instead of the Player inventory See InventoryClickEvent
void	setDragAction(@Nullable GuiAction<org.bukkit.event.inventory.InventoryDragEvent> dragAction) Sets the GuiAction of a default drag action See InventoryDragEvent
void	setItem(int slot, @NotNull GuiItem guiItem) Sets the GuiItem to a specific slot on the GUI
void	setItem(int row, int col, @NotNull GuiItem guiItem) Alternative setItem(int, GuiItem) to set item that uses ROWS and COLUMNS instead of slots
void	setItem(@NotNull List<Integer> slots, @NotNull GuiItem guiItem) Alternative setItem(int, GuiItem) to set item that takes a List of slots instead
void	setOpenGuiAction(@Nullable GuiAction<org.bukkit.event.inventory.InventoryOpenEvent> openGuiAction) Sets the GuiAction to run when the GUI opens See InventoryOpenEvent
void	setOutsideClickAction(@Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> outsideClickAction) Sets the GuiAction to run when clicking on the outside of the inventory See InventoryClickEvent
BaseGui	setRows(int rows) Sets the number of rows the GUI should have
void	setUpdating(boolean updating) Sets the updating status of the GUI
void	update() Updates the GUI for all the Inventory views
void	updateItem(int slot, @NotNull GuiItem item) Alternative updateItem(int, ItemStack) but creates a new GuiItem
void	updateItem(int row, int col, @NotNull GuiItem item) Alternative updateItem(int, GuiItem) that takes ROWS and COLUMNS instead of slots
void	updateItem(int row, int col, @NotNull org.bukkit.inventory.ItemStack itemStack) Alternative updateItem(int, ItemStack) that takes ROWS and COLUMNS instead of slots
void	updateItem(int slot, @NotNull org.bukkit.inventory.ItemStack itemStack) Updates the specified item in the GUI at runtime, without creating a new GuiItem
BaseGui	updateTitle(@NotNull String title) Updates the title of the GUI This method may cause LAG if used on a loop

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseGui

public BaseGui(int rows,
               @NotNull
               @NotNull String title)

Main constructor that takes rows

Parameters:

rows - The amount of rows the GUI should have

title - The GUI title

BaseGui

public BaseGui(@NotNull
               @NotNull GuiType guiType,
               @NotNull
               @NotNull String title)

Alternative constructor that takes GuiType instead of rows number

Parameters:

guiType - The GuiType to use

title - The GUI title

Method Detail

setRows

public BaseGui setRows(int rows)

Sets the number of rows the GUI should have

Parameters:

rows - The number of rows to set

Returns:

The GUI for easier use when declaring, works like a builder

setItem

public void setItem(int slot,
                    @NotNull
                    @NotNull GuiItem guiItem)

Sets the GuiItem to a specific slot on the GUI

Parameters:

slot - The GUI slot

guiItem - The GuiItem to add to the slot

setItem

public void setItem(@NotNull
                    @NotNull List<Integer> slots,
                    @NotNull
                    @NotNull GuiItem guiItem)

Alternative setItem(int, GuiItem) to set item that takes a List of slots instead

Parameters:

slots - The slots in which the item should go

guiItem - The GuiItem to add to the slots

setItem

public void setItem(int row,
                    int col,
                    @NotNull
                    @NotNull GuiItem guiItem)

Alternative setItem(int, GuiItem) to set item that uses ROWS and COLUMNS instead of slots

Parameters:

row - The GUI row number

col - The GUI column number

guiItem - The GuiItem to add to the slot

addItem

public void addItem(@NotNull
                    GuiItem... items)

Adds GuiItems to the GUI without specific slot It'll set the item to the next empty slot available

Parameters:

items - Varargs for specifying the GuiItems

setDefaultClickAction

public void setDefaultClickAction(@Nullable
                                  @Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultClickAction)

Sets the GuiAction of a default click on any item See InventoryClickEvent

Parameters:

defaultClickAction - GuiAction to resolve when any item is clicked

setDefaultTopClickAction

public void setDefaultTopClickAction(@Nullable
                                     @Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultTopClickAction)

Sets the GuiAction of a default click on any item on the top part of the GUI Top inventory being for example chests etc, instead of the Player inventory See InventoryClickEvent

Parameters:

defaultTopClickAction - GuiAction to resolve when clicking on the top inventory

setOutsideClickAction

public void setOutsideClickAction(@Nullable
                                  @Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> outsideClickAction)

Sets the GuiAction to run when clicking on the outside of the inventory See InventoryClickEvent

Parameters:

outsideClickAction - GuiAction to resolve when clicking outside of the inventory

setDragAction

public void setDragAction(@Nullable
                          @Nullable GuiAction<org.bukkit.event.inventory.InventoryDragEvent> dragAction)

Sets the GuiAction of a default drag action See InventoryDragEvent

Parameters:

dragAction - GuiAction to resolve

setCloseGuiAction

public void setCloseGuiAction(@Nullable
                              @Nullable GuiAction<org.bukkit.event.inventory.InventoryCloseEvent> closeGuiAction)

Sets the GuiAction to run once the inventory is closed See InventoryCloseEvent

Parameters:

closeGuiAction - GuiAction to resolve when the inventory is closed

setOpenGuiAction

public void setOpenGuiAction(@Nullable
                             @Nullable GuiAction<org.bukkit.event.inventory.InventoryOpenEvent> openGuiAction)

Sets the GuiAction to run when the GUI opens See InventoryOpenEvent

Parameters:

openGuiAction - GuiAction to resolve when opening the inventory

addSlotAction

public void addSlotAction(int slot,
                          @Nullable
                          @Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> slotAction)

Adds a GuiAction for when clicking on a specific slot See InventoryClickEvent

Parameters:

slot - The slot that will trigger the GuiAction

slotAction - GuiAction to resolve when clicking on specific slots

addSlotAction

public void addSlotAction(int row,
                          int col,
                          @Nullable
                          @Nullable GuiAction<org.bukkit.event.inventory.InventoryClickEvent> slotAction)

Alternative method for addSlotAction(int, GuiAction) to add a GuiAction to a specific slot using ROWS and COLUMNS instead of slots See InventoryClickEvent

Parameters:

row - The row of the slot

col - The column of the slot

slotAction - GuiAction to resolve when clicking on the slot

getGuiItem

@Nullable
public @Nullable GuiItem getGuiItem(int slot)

Gets a specific GuiItem on the slot

Parameters:

slot - The slot of the item

Returns:

The GuiItem on the introduced slot or null if doesn't exist

isUpdating

public boolean isUpdating()

Checks whether or not the GUI is updating

Returns:

Whether the GUI is updating or not

setUpdating

public void setUpdating(boolean updating)

Sets the updating status of the GUI

Parameters:

updating - Sets the GUI to the updating status

open

public void open(@NotNull
                 @NotNull org.bukkit.entity.HumanEntity player)

Opens the GUI for a HumanEntity

Parameters:

player - The HumanEntity to open the GUI to

close

public void close(@NotNull
                  @NotNull org.bukkit.entity.HumanEntity player)

Closes the GUI with a 2s delay (to prevent items from being taken from the Inventory)

Parameters:

player - The HumanEntity to close the GUI to

update

public void update()

Updates the GUI for all the Inventory views

updateItem

public void updateItem(int slot,
                       @NotNull
                       @NotNull org.bukkit.inventory.ItemStack itemStack)

Updates the specified item in the GUI at runtime, without creating a new GuiItem

Parameters:

slot - The slot of the item to update

itemStack - The ItemStack to replace in the original one in the GuiItem

updateItem

public void updateItem(int row,
                       int col,
                       @NotNull
                       @NotNull org.bukkit.inventory.ItemStack itemStack)

Alternative updateItem(int, ItemStack) that takes ROWS and COLUMNS instead of slots

Parameters:

row - The row of the slot

col - The columns of the slot

itemStack - The ItemStack to replace in the original one in the GuiItem

updateItem

public void updateItem(int slot,
                       @NotNull
                       @NotNull GuiItem item)

Alternative updateItem(int, ItemStack) but creates a new GuiItem

Parameters:

slot - The slot of the item to update

item - The GuiItem to replace in the original

updateItem

public void updateItem(int row,
                       int col,
                       @NotNull
                       @NotNull GuiItem item)

Alternative updateItem(int, GuiItem) that takes ROWS and COLUMNS instead of slots

Parameters:

row - The row of the slot

col - The columns of the slot

item - The GuiItem to replace in the original

updateTitle

public BaseGui updateTitle(@NotNull
                           @NotNull String title)

Updates the title of the GUI This method may cause LAG if used on a loop

Parameters:

title - The title to set

Returns:

The GUI for easier use when declaring, works like a builder

getFiller

@NotNull
public @NotNull GuiFiller getFiller()

Gets the GuiFiller that it's used for filling up the GUI in specific ways

Returns:

The GuiFiller

getGuiItems

public Map<Integer,GuiItem> getGuiItems()

Gets an immutable Map with all the GUI items

Returns:

The Map with all the guiItems

getInventory

@NotNull
public @NotNull org.bukkit.inventory.Inventory getInventory()

Gets the main Inventory of this GUI

Specified by:

getInventory in interface org.bukkit.inventory.InventoryHolder

getRows

public int getRows()

Gets the amount of rows

Returns:

The rows of the GUI