Package me.tippie.tippieutils.v1_2_0.guis

Class OpenGUI

java.lang.Object

me.tippie.tippieutils.v1_2_0.guis.OpenGUI

public class OpenGUI
extends Object

Method Summary

Modifier and Type	Method	Description
BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI>	getGeneralClickConsumer()	The general click consumer for this open GUI.
org.bukkit.inventory.Inventory	getInventory()	The inventory of the GUI.
GuiManager	getManager()	The GuiManager tracking this GUI.
@NotNull String	getName()	The name of this GUI
BiConsumer<org.bukkit.event.inventory.InventoryCloseEvent,OpenGUI>	getOnClose()	The consumer ran when the inventory is closed
HashMap<Integer,BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI>>	getSlots()	A hashmap containing the slot specific consumers for each slot set.
org.bukkit.entity.Player	getViewer()	The player viewing this GUI.
boolean	isAlwaysRunGeneralConsumer()	Whether the generalClickConsumer of this OpenGUI must always run even when there is a slot specific consumer.
boolean	isCancelNextClose()	Whether the next time this inventory attempts to close it should be kept open or not.
void	setAlwaysRunGeneralConsumer(boolean alwaysRunGeneralConsumer)	Whether the generalClickConsumer of this OpenGUI must always run even when there is a slot specific consumer.
void	setCancelNextClose(boolean cancelNextClose)	Whether the next time this inventory attempts to close it should be kept open or not.
void	setGeneralClickConsumer(BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI> generalClickConsumer)	The general click consumer for this open GUI.
void	setInventory(org.bukkit.inventory.Inventory inventory)	The inventory of the GUI.
void	setName(@NotNull String name)	The name of this GUI
void	setOnClose(BiConsumer<org.bukkit.event.inventory.InventoryCloseEvent,OpenGUI> onClose)	The consumer ran when the inventory is closed
void	setSlot(int slot, org.bukkit.inventory.ItemStack item, BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI> consumer)	Sets the item in the slot to the item.
void	setTitle(String title)	Sets the title of the open GUI.

Methods inherited from class java.lang.Object

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

Method Details

setSlot

public void setSlot(int slot,
 org.bukkit.inventory.ItemStack item,
 BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI> consumer)

Sets the item in the slot to the item.

Parameters:

slot - The slot to set the item in.

item - The item to set.

consumer - The consumer to run when the item is clicked.

See Also:

GuiBuilder.setSlot(int, ItemStack, BiConsumer)

setTitle

public void setTitle(String title)

Sets the title of the open GUI.

Parameters:

title - The title to set.

getName

@NotNull
public @NotNull String getName()

The name of this GUI

getInventory

public org.bukkit.inventory.Inventory getInventory()

The inventory of the GUI.

getViewer

public org.bukkit.entity.Player getViewer()

The player viewing this GUI.

getSlots

public HashMap<Integer,BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI>> getSlots()

A hashmap containing the slot specific consumers for each slot set.

See Also:

GuiBuilder.setSlot(int, ItemStack, BiConsumer)

getOnClose

public BiConsumer<org.bukkit.event.inventory.InventoryCloseEvent,OpenGUI> getOnClose()

The consumer ran when the inventory is closed

getGeneralClickConsumer

public BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI> getGeneralClickConsumer()

The general click consumer for this open GUI.

See Also:

setAlwaysRunGeneralConsumer(boolean), GuiBuilder.setGeneralClickConsumer(BiConsumer)

isAlwaysRunGeneralConsumer

public boolean isAlwaysRunGeneralConsumer()

Whether the generalClickConsumer of this OpenGUI must always run even when there is a slot specific consumer.

See Also:

setGeneralClickConsumer(BiConsumer), setSlot(int, ItemStack, BiConsumer), GuiBuilder.setGeneralClickConsumer(BiConsumer), GuiBuilder.setAlwaysRunGeneralConsumer(boolean), GuiBuilder.setSlot(int, ItemStack, BiConsumer)

getManager

public GuiManager getManager()

The GuiManager tracking this GUI.

isCancelNextClose

public boolean isCancelNextClose()

Whether the next time this inventory attempts to close it should be kept open or not.

Returns:

if the next time this inventory attempts to close it should be kept open or not.

setName

public void setName(@NotNull
 @NotNull String name)

The name of this GUI

setInventory

public void setInventory(org.bukkit.inventory.Inventory inventory)

The inventory of the GUI.

setOnClose

public void setOnClose(BiConsumer<org.bukkit.event.inventory.InventoryCloseEvent,OpenGUI> onClose)

The consumer ran when the inventory is closed

setGeneralClickConsumer

public void setGeneralClickConsumer(BiConsumer<org.bukkit.event.inventory.InventoryClickEvent,OpenGUI> generalClickConsumer)

The general click consumer for this open GUI.

See Also:

setAlwaysRunGeneralConsumer(boolean), GuiBuilder.setGeneralClickConsumer(BiConsumer)

setAlwaysRunGeneralConsumer

public void setAlwaysRunGeneralConsumer(boolean alwaysRunGeneralConsumer)

Whether the generalClickConsumer of this OpenGUI must always run even when there is a slot specific consumer.

See Also:

setGeneralClickConsumer(BiConsumer), setSlot(int, ItemStack, BiConsumer), GuiBuilder.setGeneralClickConsumer(BiConsumer), GuiBuilder.setAlwaysRunGeneralConsumer(boolean), GuiBuilder.setSlot(int, ItemStack, BiConsumer)

setCancelNextClose

public void setCancelNextClose(boolean cancelNextClose)

Whether the next time this inventory attempts to close it should be kept open or not.

Parameters:

cancelNextClose - Whether the next time this inventory attempts to close it should be kept open or not.