Package com.enjin.minecraft_commons.spigot.ui

Class AbstractMenu

java.lang.Object

com.enjin.minecraft_commons.spigot.ui.AbstractMenu

All Implemented Interfaces:

Container

Direct Known Subclasses:

Menu

public abstract class AbstractMenu
extends java.lang.Object
implements Container

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	KEY

Constructor Summary

Constructors

Constructor	Description
AbstractMenu(java.lang.String name, Dimension dimension)

Method Summary

Modifier and Type	Method	Description
boolean	addComponent(Position position, Component component)
void	allowPlayerInventoryInteractions(boolean state)
protected void	closeMenu(org.bukkit.entity.Player player)
boolean	contains(org.bukkit.entity.Player player)
protected abstract org.bukkit.inventory.Inventory	createInventory(org.bukkit.entity.Player player)
void	destroy()
java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu>	getCloseConsumer()
java.util.Optional<Component>	getComponent(int slot)
java.util.Optional<Component>	getComponent(Position position)
java.util.Map<Component,Position>	getComponents()
java.lang.String	getDefaultName()
Dimension	getDimension()
static org.bukkit.plugin.java.JavaPlugin	getHolder()
protected org.bukkit.inventory.Inventory	getInventory(org.bukkit.entity.Player player, boolean createIfAbsent)
protected org.bukkit.inventory.InventoryView	getInventoryView(org.bukkit.entity.Player player, boolean createIfAbsent)
java.util.Optional<org.bukkit.inventory.ItemStack>	getItem(org.bukkit.entity.Player player, Component component, Position offset)
protected static java.util.Optional<AbstractMenu>	getMenu(org.bukkit.entity.Player player)
java.lang.String	getName(org.bukkit.entity.Player player)
java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu>	getOpenConsumer()
protected int	getSize()
static boolean	hasAnyMenu(org.bukkit.entity.Player player)
boolean	hasOpen(org.bukkit.entity.Player player)
boolean	isNameSwitch()
boolean	isPlayerInventoryInteractionsAllowed()
protected void	onClose(org.bukkit.entity.Player player)
protected void	onOpen(org.bukkit.entity.Player player)
void	onPlayerQuit(org.bukkit.event.player.PlayerQuitEvent event)
AbstractMenu	open(org.bukkit.entity.Player player)
void	refresh(org.bukkit.entity.Player player)
boolean	removeComponent(Component component)
void	removePlayer(org.bukkit.entity.Player player)
AbstractMenu	setCloseConsumer(java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu> consumer)
void	setItem(org.bukkit.entity.Player player, Component component, Position offset, org.bukkit.inventory.ItemStack stack)
void	setItem(org.bukkit.entity.Player player, Position position, org.bukkit.inventory.ItemStack stack)
protected static void	setMenu(org.bukkit.entity.Player player, AbstractMenu menu)
void	setNameProvider(java.util.function.Function<org.bukkit.entity.Player,java.lang.String> provider)
AbstractMenu	setOpenConsumer(java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu> consumer)
void	update(org.bukkit.entity.Player player)
void	updateAll()

Methods inherited from class java.lang.Object

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

Field Detail

KEY

protected static final java.lang.String KEY

See Also:

Constant Field Values

Constructor Detail

AbstractMenu

public AbstractMenu(java.lang.String name,
                    Dimension dimension)

Method Detail

createInventory

protected abstract org.bukkit.inventory.Inventory createInventory(org.bukkit.entity.Player player)

getInventory

protected org.bukkit.inventory.Inventory getInventory(org.bukkit.entity.Player player,
                                                      boolean createIfAbsent)

getInventoryView

protected org.bukkit.inventory.InventoryView getInventoryView(org.bukkit.entity.Player player,
                                                              boolean createIfAbsent)

getSize

protected int getSize()

onOpen

protected void onOpen(org.bukkit.entity.Player player)

onClose

protected void onClose(org.bukkit.entity.Player player)

closeMenu

protected void closeMenu(org.bukkit.entity.Player player)

getDefaultName

public java.lang.String getDefaultName()

getOpenConsumer

public java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu> getOpenConsumer()

getCloseConsumer

public java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu> getCloseConsumer()

isNameSwitch

public boolean isNameSwitch()

setNameProvider

public void setNameProvider(java.util.function.Function<org.bukkit.entity.Player,java.lang.String> provider)

removePlayer

public void removePlayer(org.bukkit.entity.Player player)

setOpenConsumer

public AbstractMenu setOpenConsumer(java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu> consumer)

setCloseConsumer

public AbstractMenu setCloseConsumer(java.util.function.BiConsumer<org.bukkit.entity.Player,AbstractMenu> consumer)

hasOpen

public boolean hasOpen(org.bukkit.entity.Player player)

contains

public boolean contains(org.bukkit.entity.Player player)

getComponents

public java.util.Map<Component,Position> getComponents()

getComponent

public java.util.Optional<Component> getComponent(int slot)

getComponent

public java.util.Optional<Component> getComponent(Position position)

refresh

public void refresh(org.bukkit.entity.Player player)

open

public AbstractMenu open(org.bukkit.entity.Player player)

onPlayerQuit

public void onPlayerQuit(org.bukkit.event.player.PlayerQuitEvent event)

getDimension

public Dimension getDimension()

Specified by:

getDimension in interface Container

getName

public java.lang.String getName(org.bukkit.entity.Player player)

Specified by:

getName in interface Container

addComponent

public boolean addComponent(Position position,
                            Component component)

Specified by:

addComponent in interface Container

removeComponent

public boolean removeComponent(Component component)

Specified by:

removeComponent in interface Container

getItem

public java.util.Optional<org.bukkit.inventory.ItemStack> getItem(org.bukkit.entity.Player player,
                                                                  Component component,
                                                                  Position offset)

Specified by:

getItem in interface Container

setItem

public void setItem(org.bukkit.entity.Player player,
                    Component component,
                    Position offset,
                    org.bukkit.inventory.ItemStack stack)

Specified by:

setItem in interface Container

setItem

public void setItem(org.bukkit.entity.Player player,
                    Position position,
                    org.bukkit.inventory.ItemStack stack)

Specified by:

setItem in interface Container

update

public void update(org.bukkit.entity.Player player)

Specified by:

update in interface Container

updateAll

public void updateAll()

Specified by:

updateAll in interface Container

destroy

public void destroy()

Specified by:

destroy in interface Container

allowPlayerInventoryInteractions

public void allowPlayerInventoryInteractions(boolean state)

Specified by:

allowPlayerInventoryInteractions in interface Container

isPlayerInventoryInteractionsAllowed

public boolean isPlayerInventoryInteractionsAllowed()

Specified by:

isPlayerInventoryInteractionsAllowed in interface Container

getMenu

protected static java.util.Optional<AbstractMenu> getMenu(org.bukkit.entity.Player player)

setMenu

protected static void setMenu(org.bukkit.entity.Player player,
                              AbstractMenu menu)

hasAnyMenu

public static boolean hasAnyMenu(org.bukkit.entity.Player player)

getHolder

public static org.bukkit.plugin.java.JavaPlugin getHolder()