A B C D E G I L M N O P S T V

A

actions - Variable in class com.github.ms5984.api.menuman.MenuBuilder

MenuAction to slot mappings.

addElement(ItemStack) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Add a previously styled ItemStack directly to the menu.

addElement(ItemStack, String, String...) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Add an ItemStack to the menu of specified display name and lore.

addLore(String) - Method in class com.github.ms5984.api.menuman.ElementBuilder

Add a line to lore for this element.

allowClick() - Method in class com.github.ms5984.api.menuman.MenuClick

Uncancel the event and allow the click to follow through.

allowItemPickup - Variable in class com.github.ms5984.api.menuman.MenuBuilder

Allow items to be removed from the menu inventory.

allowPickupFromMenu - Variable in class com.github.ms5984.api.menuman.Menu

Defines default item pickup behavior for top inventory.

assignToSlots(int...) - Method in class com.github.ms5984.api.menuman.ElementBuilder

Assign this element to slots of the menu.

B

baseItem - Variable in class com.github.ms5984.api.menuman.MenuElement

Initial ItemStack.

C

cancelClickLower - Variable in class com.github.ms5984.api.menuman.Menu

Defines whether clicks on lower inventory are cancelled.

cancelLowerInvClick - Variable in class com.github.ms5984.api.menuman.MenuBuilder

Determine whether clicks on the lower inventory should be cancelled.

cancelLowerInventoryClicks(boolean) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Should ALL clicks on the lower inventory be cancelled as well?

ClickAction - Interface in com.github.ms5984.api.menuman

Functional interface which defines behavior on use of a Menu's actions.

CloseAction - Interface in com.github.ms5984.api.menuman

Functional interface which defines behavior on the closing of a Menu.

closeAction - Variable in class com.github.ms5984.api.menuman.MenuBuilder

Callback to run on menu close.

CloseInventory(MenuClick) - Static method in interface com.github.ms5984.api.menuman.ClickAction

Close the inventory of the player.

com.github.ms5984.api.menuman - package com.github.ms5984.api.menuman

create(JavaPlugin) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Create the Menu specified by the contents of this builder.

D

defaultClickBehavior(boolean) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Determine default pickup behavior when clicking ItemStacks.

disallowClick() - Method in class com.github.ms5984.api.menuman.MenuClick

Cancel the click event, preventing pickup of the item.

displayName - Variable in class com.github.ms5984.api.menuman.MenuElement

A custom title for the final ItemStack.

E

ElementBuilder - Class in com.github.ms5984.api.menuman

Fluent interface builder for menu elements

ElementBuilder(MenuBuilder, MenuElement) - Constructor for class com.github.ms5984.api.menuman.ElementBuilder

Create an ElementBuilder for a MenuBuilder with a MenuElement.

G

generateComplete() - Method in class com.github.ms5984.api.menuman.MenuElement

Generate the final ItemStack, styled if needed.

getClickedInventory() - Method in class com.github.ms5984.api.menuman.MenuClick.InventorySlot

Get the Inventory that was clicked.

getClickType() - Method in class com.github.ms5984.api.menuman.MenuClick

Get the ClickType of this event.

getCurrentInventory() - Method in class com.github.ms5984.api.menuman.Menu

Gets the Inventory at this exact moment.

getIndex() - Method in class com.github.ms5984.api.menuman.MenuClick.InventorySlot

Get the index of the slot.

getInventoryView() - Method in class com.github.ms5984.api.menuman.MenuClick

Get the full InventoryView of the transaction.

getInventoryView() - Method in class com.github.ms5984.api.menuman.MenuClose

Get the full InventoryView of the transaction.

getItem() - Method in class com.github.ms5984.api.menuman.MenuClick.InventorySlot

Get the item in the slot.

getItemOnMouseCursor() - Method in class com.github.ms5984.api.menuman.MenuClick

Check for the item currently on the cursor.

getPlayer() - Method in class com.github.ms5984.api.menuman.MenuClick

Get the player that clicked the Menu.

getPlayer() - Method in class com.github.ms5984.api.menuman.MenuClose

Get the player that clicked the Menu.

getSlotClicked() - Method in class com.github.ms5984.api.menuman.MenuClick

Get an Optional describing the slot clicked, if applicable.

getUpperInventory() - Method in class com.github.ms5984.api.menuman.MenuClose

Get the Menu inventory that is closing.

getViewers() - Method in class com.github.ms5984.api.menuman.Menu

Get all Players currently viewing this menu.

I

initialContents - Variable in class com.github.ms5984.api.menuman.MenuBuilder

Initial contents of the menu inventory before elements are added.

inventory - Variable in class com.github.ms5984.api.menuman.MenuClick.InventorySlot

The clicked inventory.

items - Variable in class com.github.ms5984.api.menuman.MenuBuilder

ItemStack to slot mappings.

L

lore - Variable in class com.github.ms5984.api.menuman.MenuElement

A custom description for the ItemStack.

M

Menu - Class in com.github.ms5984.api.menuman

A class representing a created Menu.

Menu(MenuBuilder, JavaPlugin) - Constructor for class com.github.ms5984.api.menuman.Menu

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

Menu.ClickListener - Class in com.github.ms5984.api.menuman

Registered listener which passes Inventory event information to the menu's actions.

Menu.InventoryRows - Enum in com.github.ms5984.api.menuman

Helpful enumeration to enforce slot parameter contract.

MenuBuilder - Class in com.github.ms5984.api.menuman

Fluid interface menu builder

MenuBuilder(Menu.InventoryRows, String) - Constructor for class com.github.ms5984.api.menuman.MenuBuilder

Create a new MenuBuilder with a number of rows and a title.

MenuBuilder(Menu.InventoryRows, String, ItemStack[]) - Constructor for class com.github.ms5984.api.menuman.MenuBuilder

Create a new MenuBuilder with rows, title and initial contents.

MenuClick - Class in com.github.ms5984.api.menuman

Class which encapsulates relevant data of InventoryClickEvent

MenuClick(InventoryClickEvent, Player) - Constructor for class com.github.ms5984.api.menuman.MenuClick

Create a MenuClick to pass to a MenuAction.

MenuClick.InventorySlot - Class in com.github.ms5984.api.menuman

An encapsulation of inventory slot interactions.

MenuClose - Class in com.github.ms5984.api.menuman

Class which encapsulates relevant data of InventoryCloseEvent

MenuClose(InventoryCloseEvent, Player) - Constructor for class com.github.ms5984.api.menuman.MenuClose

Create a MenuClose to pass to a CloseAction.

MenuElement - Class in com.github.ms5984.api.menuman

Encapsulation to promote lazy-initialization of ItemStacks

MenuElement(ItemStack) - Constructor for class com.github.ms5984.api.menuman.MenuElement

Specify MenuElement with no initial styling.

MenuElement(ItemStack, String, String...) - Constructor for class com.github.ms5984.api.menuman.MenuElement

Specify MenuElement with preconfigured styling.

N

numberOfRows - Variable in class com.github.ms5984.api.menuman.Menu

Number of rows in the generated Inventory.

numberOfRows - Variable in class com.github.ms5984.api.menuman.MenuBuilder

Describes the number of rows and slots in the final Menu.

O

onClick(MenuClick) - Method in interface com.github.ms5984.api.menuman.ClickAction

When this action is called, what should happen?

onClose(MenuClose) - Method in interface com.github.ms5984.api.menuman.CloseAction

When the menu is closed, what should happen?

onMenuClick(InventoryClickEvent) - Method in class com.github.ms5984.api.menuman.Menu.ClickListener

Process InventoryClickEvent and encapsulate to send to MenuAction if so defined.

onMenuClose(InventoryCloseEvent) - Method in class com.github.ms5984.api.menuman.Menu.ClickListener

Perform close logic and schedule cleanup.

onMenuOpen(InventoryOpenEvent) - Method in class com.github.ms5984.api.menuman.Menu.ClickListener

Process InventoryOpenEvent.

open(Player) - Method in class com.github.ms5984.api.menuman.Menu

Open this Menu for the given player.

P

player - Variable in class com.github.ms5984.api.menuman.MenuClick

The player who clicked the Menu.

player - Variable in class com.github.ms5984.api.menuman.MenuClose

The player closing the Menu.

S

setAction(ClickAction) - Method in class com.github.ms5984.api.menuman.ElementBuilder

Set a new action for this element.

setCloseAction(CloseAction) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Define a callback to run on inventory close.

setInitialContents(ItemStack[]) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Set the initial contents of the inventory.

setItem(ItemStack) - Method in class com.github.ms5984.api.menuman.ElementBuilder

Set a new base item for this element.

setItem(ItemStack) - Method in class com.github.ms5984.api.menuman.MenuClick.InventorySlot

Set a new item in the slot.

setLore(String...) - Method in class com.github.ms5984.api.menuman.ElementBuilder

Set new lore text for this element.

setText(String) - Method in class com.github.ms5984.api.menuman.ElementBuilder

Set a new display text for this element.

setTitle(String) - Method in class com.github.ms5984.api.menuman.MenuBuilder

Set a new title for the menu.

slot - Variable in class com.github.ms5984.api.menuman.MenuClick.InventorySlot

The index of the slot clicked.

slotCount - Variable in enum com.github.ms5984.api.menuman.Menu.InventoryRows

Number of slots in an Inventory of these rows.

T

title - Variable in class com.github.ms5984.api.menuman.Menu

Title of generated Inventory.

title - Variable in class com.github.ms5984.api.menuman.MenuBuilder

Title of the final Menu inventory.

V

valueOf(String) - Static method in enum com.github.ms5984.api.menuman.Menu.InventoryRows

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.ms5984.api.menuman.Menu.InventoryRows

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G I L M N O P S T V