com.github.ms5984.api.menuman

Class Menu

java.lang.Object

com.github.ms5984.api.menuman.Menu

public final class Menu
extends Object

A class representing a created Menu.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Menu.ClickListener Registered listener which passes Inventory event information to the menu's actions.
static class	Menu.InventoryRows Helpful enumeration to enforce slot parameter contract.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowPickupFromMenu Defines default item pickup behavior for top inventory.
boolean	allowShiftClickLower Defines shift-click behavior on the lower inventory.
boolean	cancelClickLower Defines whether clicks on lower inventory are cancelled.
Menu.InventoryRows	numberOfRows Number of rows in the generated Inventory.
String	title Title of generated Inventory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Menu(MenuBuilder menuBuilder, org.bukkit.plugin.java.JavaPlugin javaPlugin) Create a new Menu using the data from a builder and a plugin reference.

Method Summary

Modifier and Type	Method and Description
Optional<org.bukkit.inventory.Inventory>	getCurrentInventory() Gets the Inventory at this exact moment.
Set<org.bukkit.entity.Player>	getViewers() Get all Players currently viewing this menu.
void	open(org.bukkit.entity.Player player) Open this Menu for the given player.

Methods inherited from class java.lang.Object

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

Field Detail

numberOfRows

public final Menu.InventoryRows numberOfRows

Number of rows in the generated Inventory.

title

public final String title

Title of generated Inventory.

cancelClickLower

public final boolean cancelClickLower

Defines whether clicks on lower inventory are cancelled.

allowPickupFromMenu

public final boolean allowPickupFromMenu

Defines default item pickup behavior for top inventory.

allowShiftClickLower

public final boolean allowShiftClickLower

Defines shift-click behavior on the lower inventory.

Constructor Detail

Menu

protected Menu(MenuBuilder menuBuilder,
               org.bukkit.plugin.java.JavaPlugin javaPlugin)

Create a new Menu using the data from a builder and a plugin reference.

Parameters:

menuBuilder - a MenuBuilder

javaPlugin - your plugin

Method Detail

open

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

Open this Menu for the given player.

Parameters:

player - player to open menu for

getCurrentInventory

public Optional<org.bukkit.inventory.Inventory> getCurrentInventory()

Gets the Inventory at this exact moment.

Expressed as an Optional (no viewers = no Inventory).

Not async safe.

Returns:

an Optional describing the currently generated Inventory

getViewers

public Set<org.bukkit.entity.Player> getViewers()

Get all Players currently viewing this menu.

Returns an empty set if inventory == null

Returns:

a set of Players viewing this menu