me.redstonefreak589.pcg.api

Class Menu

java.lang.Object

me.redstonefreak589.pcg.api.Menu

All Implemented Interfaces:

org.bukkit.inventory.InventoryHolder

public class Menu
extends java.lang.Object
implements org.bukkit.inventory.InventoryHolder

Constructor Summary

Constructors

Constructor and Description
Menu(java.lang.String title, int rows) Creates a standard menu object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addMenuItem(MenuItem item, int index) Adds a menu item.
boolean	addMenuItem(MenuItem item, int x, int y) Adds a menu item to the row and slot.
void	closeMenu(org.bukkit.entity.Player player) Closes the menu of a player.
boolean	exitOnClickOutside() Get's the exitOnClickOuside, used in if() statements.
org.bukkit.inventory.Inventory	getInventory()
MenuCloseBehaviour	getMenuCloseBehaviour() Get's whether the menu is closed when clicked outside the border.
void	openMenu(org.bukkit.entity.Player player) Show's the menu to a player.
boolean	removeMenuItem(int index) Removes an item from the menu.
boolean	removeMenuItem(int x, int y) Removes a menu item from a row and slot.
void	setExitOnClickOutside(boolean exit) Determines whether the menu is closed when clicked outside the border.
void	setMenuCloseBehaviour(MenuCloseBehaviour menuCloseBehaviour) Set's the menu close behavior.
void	switchMenu(org.bukkit.entity.Player player, Menu toMenu) Switches the menu object to a different menu.
void	updateMenu()

Methods inherited from class java.lang.Object

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

Constructor Detail

Menu

public Menu(java.lang.String title,
    int rows)

Creates a standard menu object

Parameters:

title - The title of the menu, in a string.

rows - The number of rows.

Method Detail

setMenuCloseBehaviour

public void setMenuCloseBehaviour(MenuCloseBehaviour menuCloseBehaviour)

Set's the menu close behavior.

Parameters:

menuCloseBehaviour - The menu close behavior.

getMenuCloseBehaviour

public MenuCloseBehaviour getMenuCloseBehaviour()

Get's whether the menu is closed when clicked outside the border.

Returns:

menuCloseBehaviour

setExitOnClickOutside

public void setExitOnClickOutside(boolean exit)

Determines whether the menu is closed when clicked outside the border. Takes a boolean.

Parameters:

exit - exitOnClickOutside

addMenuItem

public boolean addMenuItem(MenuItem item,
                  int x,
                  int y)

Adds a menu item to the row and slot.

Parameters:

item - MenuItem

x - Slot

y - Row

Returns:

addMenuItem(item, y * 9 + x)

addMenuItem

public boolean addMenuItem(MenuItem item,
                  int index)

Adds a menu item.

Parameters:

item - MenuItem

index - Slot

Returns:

true

removeMenuItem

public boolean removeMenuItem(int x,
                     int y)

Removes a menu item from a row and slot.

Parameters:

x - Slot

y - Row

Returns:

removeMenuItem(y * 9 + x)

removeMenuItem

public boolean removeMenuItem(int index)

Removes an item from the menu. If the menu is already open, use the updateMenu() method.

Parameters:

index - Slot

Returns:

true

openMenu

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

Show's the menu to a player.

Parameters:

player - Player

closeMenu

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

Closes the menu of a player. Useful for the onClick() method.

Parameters:

player - Player

switchMenu

public void switchMenu(org.bukkit.entity.Player player,
              Menu toMenu)

Switches the menu object to a different menu.

Parameters:

player - Player

toMenu - Menu to switch to. Menu Object

getInventory

public org.bukkit.inventory.Inventory getInventory()

Specified by:

getInventory in interface org.bukkit.inventory.InventoryHolder

exitOnClickOutside

public boolean exitOnClickOutside()

Get's the exitOnClickOuside, used in if() statements.

Returns:

exitOnClickOutside

updateMenu

public void updateMenu()