me.mrCookieSlime.CSCoreLibPlugin.general.Inventory

Class ChestMenu

java.lang.Object

me.mrCookieSlime.CSCoreLibPlugin.general.Inventory.ChestMenu

Direct Known Subclasses:

DroppingChestMenu

public class ChestMenu
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChestMenu.MenuClickHandler
static interface	ChestMenu.MenuCloseHandler
static interface	ChestMenu.MenuOpeningHandler

Constructor Summary

Constructors

Constructor and Description
ChestMenu(java.lang.String title) Creates a new ChestMenu with the specified Title

Method Summary

Modifier and Type	Method and Description
ChestMenu	addItem(int slot, org.bukkit.inventory.ItemStack item) Adds an Item to the Inventory in that Slot
ChestMenu	addItem(int slot, org.bukkit.inventory.ItemStack item, ChestMenu.MenuClickHandler clickHandler) Adds an Item to the Inventory in that Slot as well as a Click Handler
ChestMenu	addMenuClickHandler(int slot, ChestMenu.MenuClickHandler handler) Executes a certain Action upon clicking an Item in the Menu
ChestMenu	addMenuCloseHandler(ChestMenu.MenuCloseHandler handler) Executes a certain Action upon closing this Menu
ChestMenu	addMenuOpeningHandler(ChestMenu.MenuOpeningHandler handler) Executes a certain Action upon opening this Menu
ChestMenu	build() Deprecated.
org.bukkit.inventory.ItemStack[]	getContents() Returns an Array containing the Contents of this Inventory
org.bukkit.inventory.ItemStack	getItemInSlot(int slot) Returns the ItemStack in that Slot
ChestMenu.MenuClickHandler	getMenuClickHandler(int slot) Returns the MenuClickHandler which was registered for the specified Slot
ChestMenu.MenuCloseHandler	getMenuCloseHandler() Returns the registered MenuCloseHandler
boolean	isPlayerInventoryClickable() Returns whether the Player's Inventory is accessible while viewing this Menu
void	open(org.bukkit.entity.Player... players) Opens this Menu for the specified Player/s
void	replaceExistingItem(int slot, org.bukkit.inventory.ItemStack item) Modifies an ItemStack in an ALREADY OPENED ChestMenu
void	reset() Resets this ChestMenu to a Point BEFORE the User interacted with it
ChestMenu	setPlayerInventoryClickable(boolean clickable) Toggles whether Players can access there Inventory while viewing this Menu
org.bukkit.inventory.Inventory	toInventory() Converts this ChestMenu Instance into a normal Inventory

Methods inherited from class java.lang.Object

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

Constructor Detail

ChestMenu

public ChestMenu(java.lang.String title)

Creates a new ChestMenu with the specified Title

Parameters:

title - The title of the Menu

Method Detail

setPlayerInventoryClickable

public ChestMenu setPlayerInventoryClickable(boolean clickable)

Toggles whether Players can access there Inventory while viewing this Menu

Parameters:

clickable - Whether the Player can access his Inventory

Returns:

The ChestMenu Instance

isPlayerInventoryClickable

public boolean isPlayerInventoryClickable()

Returns whether the Player's Inventory is accessible while viewing this Menu

Returns:

Whether the Player Inventory is clickable

addItem

public ChestMenu addItem(int slot,
                         org.bukkit.inventory.ItemStack item)

Adds an Item to the Inventory in that Slot

Parameters:

slot - The Slot in the Inventory

item - The Item for that Slot

Returns:

The ChestMenu Instance

addItem

public ChestMenu addItem(int slot,
                         org.bukkit.inventory.ItemStack item,
                         ChestMenu.MenuClickHandler clickHandler)

Adds an Item to the Inventory in that Slot as well as a Click Handler

Parameters:

slot - The Slot in the Inventory

item - The Item for that Slot

handler - The MenuClickHandler for that Slot

Returns:

The ChestMenu Instance

getItemInSlot

public org.bukkit.inventory.ItemStack getItemInSlot(int slot)

Returns the ItemStack in that Slot

Parameters:

slot - The Slot in the Inventory

Returns:

The ItemStack in that Slot

addMenuClickHandler

public ChestMenu addMenuClickHandler(int slot,
                                     ChestMenu.MenuClickHandler handler)

Executes a certain Action upon clicking an Item in the Menu

Parameters:

slot - The Slot in the Inventory

handler - The MenuClickHandler

Returns:

The ChestMenu Instance

addMenuOpeningHandler

public ChestMenu addMenuOpeningHandler(ChestMenu.MenuOpeningHandler handler)

Executes a certain Action upon opening this Menu

Parameters:

handler - The MenuOpeningHandler

Returns:

The ChestMenu Instance

addMenuCloseHandler

public ChestMenu addMenuCloseHandler(ChestMenu.MenuCloseHandler handler)

Executes a certain Action upon closing this Menu

Parameters:

handler - The MenuCloseHandler

Returns:

The ChestMenu Instance

build

@Deprecated
public ChestMenu build()

Deprecated.

Finishes the Creation of the Menu

Returns:

The ChestMenu Instance

getContents

public org.bukkit.inventory.ItemStack[] getContents()

Returns an Array containing the Contents of this Inventory

Returns:

The Contents of this Inventory

reset

public void reset()

Resets this ChestMenu to a Point BEFORE the User interacted with it

replaceExistingItem

public void replaceExistingItem(int slot,
                                org.bukkit.inventory.ItemStack item)

Modifies an ItemStack in an ALREADY OPENED ChestMenu

Parameters:

slot - The Slot of the Item which will be replaced

item - The new Item

open

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

Opens this Menu for the specified Player/s

Parameters:

players - The Players who will see this Menu

getMenuClickHandler

public ChestMenu.MenuClickHandler getMenuClickHandler(int slot)

Returns the MenuClickHandler which was registered for the specified Slot

Parameters:

slot - The Slot in the Inventory

Returns:

The MenuClickHandler registered for the specified Slot

getMenuCloseHandler

public ChestMenu.MenuCloseHandler getMenuCloseHandler()

Returns the registered MenuCloseHandler

Returns:

The registered MenuCloseHandler

toInventory

public org.bukkit.inventory.Inventory toInventory()

Converts this ChestMenu Instance into a normal Inventory

Returns:

The converted Inventory