eu.wauz.wauzcore.menu

Class MaterialPouch

java.lang.Object

eu.wauz.wauzcore.menu.MaterialPouch

All Implemented Interfaces:

WauzInventory

public class MaterialPouch
extends java.lang.Object
implements WauzInventory

An inventory that can be used as menu or for other custom interaction mechanics. Represents a virtual chest, to store materials and quest items of a player.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,org.bukkit.inventory.Inventory>	inventoryMap A map of cached inventories.
private java.lang.String	inventoryName The name of the inventory, representing the section of the pouch to show.

Constructor Summary

Constructors

Modifier	Constructor and Description
	MaterialPouch() Creates a new menu to display the contents of the materials section of the material pouch.
private	MaterialPouch(java.lang.String inventoryName) Creates a new menu to display the contents of the given section of the material pouch.

Method Summary

Modifier and Type	Method and Description
static boolean	addItem(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack itemStack, java.lang.String inventoryName) Let's the player add an item to the inventory, if there is enough space.
java.util.List<WauzMode>	getGamemodes()
static org.bukkit.inventory.Inventory	getInventory(org.bukkit.entity.Player player, java.lang.String inventoryName) Gets or creates / loads the inventory with the given name for the player.
java.lang.String	getInventoryId()
static void	open(org.bukkit.entity.Player player) Opens the menu for the given player.
static void	open(org.bukkit.entity.Player player, java.lang.String inventoryName) Opens the menu for the given player.
void	openInstance(org.bukkit.entity.Player player) Opens a new inventory of this type for the given player.
void	selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event) Checks if an event in this inventory was triggered by a player click.
static void	unloadInventory(org.bukkit.entity.Player player, java.lang.String inventoryName) Unloads the cache of the inventory with the given name for the player.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.wauz.wauzcore.menu.util.WauzInventory

destroyInventory

Field Detail

inventoryMap

private static final java.util.Map<java.lang.String,org.bukkit.inventory.Inventory> inventoryMap

A map of cached inventories.

inventoryName

private java.lang.String inventoryName

The name of the inventory, representing the section of the pouch to show.

Constructor Detail

MaterialPouch

public MaterialPouch()

Creates a new menu to display the contents of the materials section of the material pouch.

MaterialPouch

private MaterialPouch(java.lang.String inventoryName)

Creates a new menu to display the contents of the given section of the material pouch.

Parameters:

inventoryName - The name of the inventory, representing the section of the pouch to show.

Method Detail

getInventoryId

public java.lang.String getInventoryId()

Specified by:

getInventoryId in interface WauzInventory

Returns:

The id of the inventory.

getGamemodes

public java.util.List<WauzMode> getGamemodes()

Specified by:

getGamemodes in interface WauzInventory

Returns:

The modes in which the inventory can be opened.

openInstance

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

Opens a new inventory of this type for the given player.

Specified by:

openInstance in interface WauzInventory

Parameters:

player - The player that should view the inventory.

open

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

Opens the menu for the given player. Shows the contents of the default section of the material pouch.

Parameters:

player - The player that should view the inventory.

See Also:

open(Player, String)

open

public static void open(org.bukkit.entity.Player player,
                        java.lang.String inventoryName)

Opens the menu for the given player. Shows the contents of the given section of the material pouch.

Parameters:

player - The player that should view the inventory.

inventoryName - The name of the inventory, representing the section of the pouch to show.

See Also:

MenuUtils.setBorders(Inventory)

getInventory

public static org.bukkit.inventory.Inventory getInventory(org.bukkit.entity.Player player,
                                                          java.lang.String inventoryName)

Gets or creates / loads the inventory with the given name for the player.

Parameters:

player - The player who owns the pouch that contains the inventory.

inventoryName - The name of the inventory.

Returns:

The inventory.

unloadInventory

public static void unloadInventory(org.bukkit.entity.Player player,
                                   java.lang.String inventoryName)

Unloads the cache of the inventory with the given name for the player.

Parameters:

player - The player who owns the pouch that contains the inventory.

inventoryName - The name of the inventory.

addItem

public static boolean addItem(org.bukkit.entity.Player player,
                              org.bukkit.inventory.ItemStack itemStack,
                              java.lang.String inventoryName)

Let's the player add an item to the inventory, if there is enough space.

Parameters:

player - The player who owns the pouch that contains the inventory.

itemStack - The item stack to add to the inventory.

inventoryName - The name of the inventory.

Returns:

If the item fit inside the inventory.

selectMenuPoint

public void selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event)

Checks if an event in this inventory was triggered by a player click. Cancels the event and lets the player change views or sell materials.

Specified by:

selectMenuPoint in interface WauzInventory

Parameters:

event - The inventory click event.

See Also:

WauzShopActions.sell(Player, ItemStack, boolean), WauzPlayerEventMaterialsSell, open(Player, String)