eu.wauz.wauzcore.menu

Class WauzMenu

java.lang.Object

eu.wauz.wauzcore.menu.WauzMenu

All Implemented Interfaces:

CustomItem, WauzInventory

public class WauzMenu
extends java.lang.Object
implements WauzInventory, CustomItem

An inventory that can be used as menu or for other custom interaction mechanics. The main menu of the game, that will by default show all sub menus of the MMORPG mode.

Author:

Wauzmons

See Also:

WauzModeMenu

Constructor Summary

Constructors

Constructor and Description
WauzMenu()

Method Summary

Modifier and Type	Method and Description
java.util.List<org.bukkit.Material>	getCustomItemMaterials() Returns the materials that trigger events with the item.
java.util.List<WauzMode>	getGamemodes()
java.lang.String	getInventoryId()
static void	open(org.bukkit.entity.Player player) 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.
void	use(org.bukkit.event.player.PlayerInteractEvent event) Handles the interaction with the menu opener item.

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

Constructor Detail

WauzMenu

public WauzMenu()

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.

use

public void use(org.bukkit.event.player.PlayerInteractEvent event)

Handles the interaction with the menu opener item.

Specified by:

use in interface CustomItem

Parameters:

event - The interaction event.

getCustomItemMaterials

public java.util.List<org.bukkit.Material> getCustomItemMaterials()

Returns the materials that trigger events with the item.

Specified by:

getCustomItemMaterials in interface CustomItem

Returns:

The list of materials.

open

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

Opens the menu for the given player. If it is opened in the hub, it will be redirected to the mode selection. Else all sub menus of the MMORPG mode plus a short information is shown. This includes the ability, collection and social menus.

Parameters:

player - The player that should view the inventory.

See Also:

WauzModeMenu.open(Player), SocialMenuParts.addMenuParts(Player, Inventory, int), CollectionMenuParts.addMenuParts(Player, Inventory, int), AbilityMenuParts.addMenuParts(Player, Inventory, int), MenuUtils.setBorders(Inventory)

selectMenuPoint

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

Checks if an event in this inventory was triggered by a player click. The default event will be automatically canceled. If a sub menu was clicked, it will be opened.

Specified by:

selectMenuPoint in interface WauzInventory

Parameters:

event - The inventory click event.

See Also:

SocialMenuParts.check(Player, ItemStack), CollectionMenuParts.check(Player, ItemStack), AbilityMenuParts.check(Player, ItemStack)