eu.wauz.wauzcore.menu.util

Class MenuUtils

java.lang.Object

eu.wauz.wauzcore.menu.util.MenuUtils

public class MenuUtils
extends java.lang.Object

An util class for creating and checking menu items.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<org.bukkit.Material>	staticItems A list of items to block interactions for, in MMORPG mode.

Constructor Summary

Constructors

Constructor and Description
MenuUtils()

Method Summary

Modifier and Type	Method and Description
static void	addItemLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String loreLine, boolean replaceAll) Adds a lore line to an item stack.
static boolean	checkForStaticItem(org.bukkit.inventory.ItemStack itemStack) Checks if the given item stack is a static item.
static void	checkForStaticItemDrop(org.bukkit.event.player.PlayerDropItemEvent event) Prevents the dropping of static and cosmetic items.
private static boolean	isHotbarItemInteractionValid(org.bukkit.event.inventory.InventoryClickEvent event) Prevents interactions with static and cosmetic items on hotbar number press.
static void	onSpecialItemInventoryClick(org.bukkit.event.inventory.InventoryClickEvent event) Prevents interactions with static and cosmetic items on click.
static int	roundInventorySize(int inventorySize) Rounds the given inventory size, to a valid chest size.
static void	setBackpack(org.bukkit.inventory.Inventory menu, int index) Sets a backpack to an inventory slot.
static void	setBorders(org.bukkit.inventory.Inventory menu) Sets borders (unnamed iron bars) to all free slots in an inventory.
static void	setComingSoon(org.bukkit.inventory.Inventory menu, java.lang.String lore, int index) Sets a coming soon sign with an optional label to an inventory slot.
static void	setCurrencyDisplay(org.bukkit.inventory.Inventory menu, org.bukkit.entity.Player player, int index) Sets a currency and reputation display to an inventory slot.
static void	setGlobalCurrencyDisplay(org.bukkit.inventory.Inventory menu, org.bukkit.entity.Player player, int index) Sets a global token display to an inventory slot.
static void	setItemDisplayName(org.bukkit.inventory.ItemStack itemStack, java.lang.String displayName) Sets the display name of an item stack.
static void	setMainMenuOpener(org.bukkit.inventory.Inventory menu, int index)
static void	setMaterials(org.bukkit.inventory.Inventory menu, int index) Sets a material bag to an inventory slot.
static void	setMenuItem(org.bukkit.inventory.Inventory menu, int slot, org.bukkit.inventory.ItemStack itemStack, java.lang.String displayName, java.util.List<java.lang.String> lores) Creates and sets a new menu item in an inventory.
static void	setTrashcan(org.bukkit.inventory.Inventory menu, int index) Sets a trashcan to an inventory slot.

Methods inherited from class java.lang.Object

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

Field Detail

staticItems

private static java.util.List<org.bukkit.Material> staticItems

A list of items to block interactions for, in MMORPG mode.

Constructor Detail

MenuUtils

public MenuUtils()

Method Detail

setMainMenuOpener

public static void setMainMenuOpener(org.bukkit.inventory.Inventory menu,
                                     int index)

setCurrencyDisplay

public static void setCurrencyDisplay(org.bukkit.inventory.Inventory menu,
                                      org.bukkit.entity.Player player,
                                      int index)

Sets a currency and reputation display to an inventory slot.

Parameters:

menu - The menu inventory.

player - The player whose currencies should be shown.

index - The slot to use in the inventory.

setGlobalCurrencyDisplay

public static void setGlobalCurrencyDisplay(org.bukkit.inventory.Inventory menu,
                                            org.bukkit.entity.Player player,
                                            int index)

Sets a global token display to an inventory slot.

Parameters:

menu - The menu inventory.

player - The player whose currencies should be shown.

index - The slot to use in the inventory.

setTrashcan

public static void setTrashcan(org.bukkit.inventory.Inventory menu,
                               int index)

Sets a trashcan to an inventory slot.

Parameters:

menu - The menu inventory.

index - The slot to use in the inventory.

setMaterials

public static void setMaterials(org.bukkit.inventory.Inventory menu,
                                int index)

Sets a material bag to an inventory slot.

Parameters:

menu - The menu inventory.

index - The slot to use in the inventory.

setBackpack

public static void setBackpack(org.bukkit.inventory.Inventory menu,
                               int index)

Sets a backpack to an inventory slot.

Parameters:

menu - The menu inventory.

index - The slot to use in the inventory.

setComingSoon

public static void setComingSoon(org.bukkit.inventory.Inventory menu,
                                 java.lang.String lore,
                                 int index)

Sets a coming soon sign with an optional label to an inventory slot.

Parameters:

menu - The menu inventory.

lore - The optional label in the lore of the sign.

index - The slot to use in the inventory.

setBorders

public static void setBorders(org.bukkit.inventory.Inventory menu)

Sets borders (unnamed iron bars) to all free slots in an inventory.

Parameters:

menu - The menu inventory.

setMenuItem

public static void setMenuItem(org.bukkit.inventory.Inventory menu,
                               int slot,
                               org.bukkit.inventory.ItemStack itemStack,
                               java.lang.String displayName,
                               java.util.List<java.lang.String> lores)

Creates and sets a new menu item in an inventory.

Parameters:

menu - The menu inventory.

slot - The slot to place the menu item stack in.

itemStack - The base item stack.

displayName - The display name of the menu item stack.

lores - The lores of the menu item stack.

setItemDisplayName

public static void setItemDisplayName(org.bukkit.inventory.ItemStack itemStack,
                                      java.lang.String displayName)

Sets the display name of an item stack.

Parameters:

itemStack - The item to set the display name for.

displayName - The new display name.

addItemLore

public static void addItemLore(org.bukkit.inventory.ItemStack itemStack,
                               java.lang.String loreLine,
                               boolean replaceAll)

Adds a lore line to an item stack.

Parameters:

itemStack - The item stack which receives the lore.

loreLine - The lore line to add to the item stack.

replaceAll - If existing lore should be replaced.

roundInventorySize

public static int roundInventorySize(int inventorySize)

Rounds the given inventory size, to a valid chest size.

Parameters:

inventorySize - The raw inventory size.

Returns:

The rounded inventory size.

onSpecialItemInventoryClick

public static void onSpecialItemInventoryClick(org.bukkit.event.inventory.InventoryClickEvent event)

Prevents interactions with static and cosmetic items on click. Also triggers scroll effects and the main menu opening.

Parameters:

event - The inventory click event.

isHotbarItemInteractionValid

private static boolean isHotbarItemInteractionValid(org.bukkit.event.inventory.InventoryClickEvent event)

Prevents interactions with static and cosmetic items on hotbar number press.

Parameters:

event - The inventory click event.

Returns:

If the event was not cancelled.

checkForStaticItemDrop

public static void checkForStaticItemDrop(org.bukkit.event.player.PlayerDropItemEvent event)

Prevents the dropping of static and cosmetic items.

Parameters:

event - The drop event.

checkForStaticItem

public static boolean checkForStaticItem(org.bukkit.inventory.ItemStack itemStack)

Checks if the given item stack is a static item. No null check included.

Parameters:

itemStack - The item stack to check.

Returns:

If it is a static item.