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

Constructor Summary

Constructors

Constructor and Description
BaseGui(@NotNull org.bukkit.plugin.Plugin plugin, int rows, @NotNull String title) Main GUI constructor
BaseGui(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull String title) GUI constructor with only title for easier 1 row GUIs

Method Summary

Modifier and Type	Method and Description
BaseGui	addItem(GuiItem... items) Adds items to the GUI without specific slot
BaseGui	addSlotAction(int slot, GuiAction<org.bukkit.event.inventory.InventoryClickEvent> slotAction) Adds a Gui Action for when clicking on a specific slot
BaseGui	addSlotAction(int row, int col, GuiAction<org.bukkit.event.inventory.InventoryClickEvent> slotAction) Adds a Gui Action for when clicking on a specific slot with row and col instead
void	close(@NotNull org.bukkit.entity.Player player) Closes the gui
GuiFiller	getFiller() Return the GUI filler with the filling methods
GuiItem	getGuiItem(int slot) Gets a specific GuiItem on the slot
Map<Integer,GuiItem>	getGuiItems() Gets map with all the GUI items
@NotNull org.bukkit.inventory.Inventory	getInventory() Gets the main inventory holder
int	getRows() Gets the amount of rows
boolean	isUpdating() Checks weather or not the GUI is updating
void	open(@NotNull org.bukkit.entity.HumanEntity player) Opens the GUI for a player
BaseGui	setCloseGuiAction(GuiAction<org.bukkit.event.inventory.InventoryCloseEvent> closeGuiAction) Sets the action of what to do when GUI closes
BaseGui	setDefaultClickAction(GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultClickAction) Sets the action of a default click on any item
BaseGui	setDefaultTopClickAction(GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultTopClickAction) Sets the action of a default click on any item on the top part of the GUI
BaseGui	setDragAction(GuiAction<org.bukkit.event.inventory.InventoryDragEvent> dragAction) Sets the action of a default drag action
BaseGui	setItem(int slot, @NotNull GuiItem guiItem) Add an item to the GUI
BaseGui	setItem(int row, int col, @NotNull GuiItem guiItem) Add an item to the GUI
BaseGui	setItem(@NotNull List<Integer> slots, @NotNull GuiItem guiItem) Sets a GUI item to many slots
BaseGui	setOpenGuiAction(GuiAction<org.bukkit.event.inventory.InventoryOpenEvent> openGuiAction) Sets the action of what to do when GUI opens
BaseGui	setOutsideClickAction(GuiAction<org.bukkit.event.inventory.InventoryClickEvent> outsideClickAction) Sets the action of when clicking on the outside of the inventory
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() Method to update the current opened GUI
void	updateItem(int slot, @NotNull GuiItem item) Used for updating the current item in the GUI at runtime
void	updateItem(int row, int col, @NotNull GuiItem item) Used for updating the current item in the GUI at runtime
void	updateItem(int row, int col, @NotNull org.bukkit.inventory.ItemStack itemStack) Used for updating the current item in the GUI at runtime
void	updateItem(int slot, @NotNull org.bukkit.inventory.ItemStack itemStack) Used for updating the current item in the GUI at runtime
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(@NotNull
               @NotNull org.bukkit.plugin.Plugin plugin,
               int rows,
               @NotNull
               @NotNull String title)

Main GUI constructor

Parameters:

plugin - The plugin

rows - How many rows you want

title - The GUI's title

BaseGui

public BaseGui(@NotNull
               @NotNull org.bukkit.plugin.Plugin plugin,
               @NotNull
               @NotNull String title)

GUI constructor with only title for easier 1 row GUIs

Parameters:

plugin - The plugin

title - The GUI's 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

setItem

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

Add an item to the GUI

Parameters:

slot - The GUI slot

guiItem - The GUI item to add

Returns:

The GUI

setItem

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

Sets a GUI item to many slots

Parameters:

slots - The slots in which the item should go

guiItem - The Gui Item to add

Returns:

The GUI

setItem

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

Add an item to the GUI

Parameters:

row - The GUI row number

col - The GUI col number

guiItem - The GUI item to add

Returns:

The GUI

addItem

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

Adds items to the GUI without specific slot

Parameters:

items - The Gui Items

Returns:

The GUI

setDefaultClickAction

public BaseGui setDefaultClickAction(GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultClickAction)

Sets the action of a default click on any item

Parameters:

defaultClickAction - Action to resolve

Returns:

The GUI

setDefaultTopClickAction

public BaseGui setDefaultTopClickAction(GuiAction<org.bukkit.event.inventory.InventoryClickEvent> defaultTopClickAction)

Sets the action of a default click on any item on the top part of the GUI

Parameters:

defaultTopClickAction - Action to resolve

Returns:

The GUI

setDragAction

public BaseGui setDragAction(GuiAction<org.bukkit.event.inventory.InventoryDragEvent> dragAction)

Sets the action of a default drag action

Parameters:

dragAction - Action to resolve

Returns:

The GUI

setCloseGuiAction

public BaseGui setCloseGuiAction(GuiAction<org.bukkit.event.inventory.InventoryCloseEvent> closeGuiAction)

Sets the action of what to do when GUI closes

Parameters:

closeGuiAction - Action to resolve

Returns:

The GUI

setOutsideClickAction

public BaseGui setOutsideClickAction(GuiAction<org.bukkit.event.inventory.InventoryClickEvent> outsideClickAction)

Sets the action of when clicking on the outside of the inventory

Parameters:

outsideClickAction - Action to resolve

Returns:

The GUI

setOpenGuiAction

public BaseGui setOpenGuiAction(GuiAction<org.bukkit.event.inventory.InventoryOpenEvent> openGuiAction)

Sets the action of what to do when GUI opens

Parameters:

openGuiAction - Action to resolve

Returns:

The GUI

addSlotAction

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

Adds a Gui Action for when clicking on a specific slot

Parameters:

slot - The slot to add

slotAction - The gui action

Returns:

The GUI

addSlotAction

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

Adds a Gui Action for when clicking on a specific slot with row and col instead

Parameters:

row - The row of the slot

col - The col of the slot

slotAction - The gui action

Returns:

The GUI

getGuiItem

public GuiItem getGuiItem(int slot)

Gets a specific GuiItem on the slot

Parameters:

slot - The slot to get

Returns:

The GUI

isUpdating

public boolean isUpdating()

Checks weather or not the GUI is updating

Returns:

If it's updating or not

setUpdating

public void setUpdating(boolean updating)

Sets the updating status of the GUI

Parameters:

updating - Sets updating

open

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

Opens the GUI for a player

Parameters:

player - The player to open it to

close

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

Closes the gui

Parameters:

player - The player to close the GUI to

update

public void update()

Method to update the current opened GUI

updateItem

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

Used for updating the current item in the GUI at runtime

Parameters:

slot - The slot of the item to update

itemStack - The new ItemStack

updateItem

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

Used for updating the current item in the GUI at runtime

Parameters:

row - The row of the slot

col - The col of the slot

itemStack - The new ItemStack

updateItem

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

Used for updating the current item in the GUI at runtime

Parameters:

slot - The slot of the item to update

item - The new ItemStack

updateItem

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

Used for updating the current item in the GUI at runtime

Parameters:

row - The row of the slot

col - The col of the slot

item - The new ItemStack

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

getFiller

public GuiFiller getFiller()

Return the GUI filler with the filling methods

Returns:

The GUI filler

getGuiItems

public Map<Integer,GuiItem> getGuiItems()

Gets map with all the GUI items

Returns:

The map with all the items

getInventory

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

Gets the main inventory holder

Specified by:

getInventory in interface org.bukkit.inventory.InventoryHolder

getRows

public int getRows()

Gets the amount of rows

Returns:

The amount of rows the GUI has