gyurix.spigotutils

Class ItemUtils

java.lang.Object

gyurix.spigotutils.ItemUtils

public class ItemUtils
extends java.lang.Object

Utils for managing items

Constructor Summary

Constructors

Constructor and Description
ItemUtils()

Method Summary

Modifier and Type	Method and Description
static int	addItem(org.bukkit.inventory.Inventory inv, org.bukkit.inventory.ItemStack is) Adds the given item to the given inventory with the default max stack size
static int	addItem(org.bukkit.inventory.Inventory inv, org.bukkit.inventory.ItemStack is, int maxStack) Adds the given item to the given inventory
static org.bukkit.inventory.ItemStack	addLore(org.bukkit.inventory.ItemStack is, java.util.List<java.lang.String> lore, java.lang.Object... vars)
static org.bukkit.inventory.ItemStack	addLore(org.bukkit.inventory.ItemStack is, java.lang.String... lore)
static org.bukkit.inventory.ItemStack	addLoreStorageMeta(org.bukkit.inventory.ItemStack is, java.lang.Object... values) Adds the given lore storage meta to the given item
static boolean	containsItem(java.lang.Iterable<org.bukkit.inventory.ItemStack> source, org.bukkit.inventory.ItemStack is) A truth check if an iterable contains the given typed item or not
static int	countItem(org.bukkit.inventory.Inventory inv, org.bukkit.inventory.ItemStack is) Counts the given item in the given inventory
static int	countItemSpace(org.bukkit.inventory.Inventory inv, org.bukkit.inventory.ItemStack is, int maxStack) Counts the available space for the given item in the given inventory
static org.bukkit.inventory.ItemStack	fillVariables(org.bukkit.inventory.ItemStack is, java.lang.Object... vars) Fill variables in a ItemStack Available special variables: #amount: the amount value of the item #id: the id of the item #sub: the subid of the item
static org.bukkit.inventory.ItemStack	fillVariables(org.bukkit.entity.Player plr, org.bukkit.inventory.ItemStack is)
static org.bukkit.inventory.ItemStack	getItem(java.lang.String name) Get the numeric id of the given itemname, it works for both numeric and text ids.
static java.lang.String	getLoreStorageMeta(org.bukkit.inventory.ItemStack is, java.lang.String format, java.lang.String def) Gets the given lore storage meta from the given ItemStack
static java.lang.String	getName(org.bukkit.inventory.ItemStack is) Gets the name of the given item
static org.bukkit.inventory.ItemStack	glow(org.bukkit.inventory.ItemStack item) Makes item glowing by adding luck 1 enchant to it and hide enchants attribute
static boolean	itemEqual(org.bukkit.inventory.ItemStack item1, org.bukkit.inventory.ItemStack item2) A truth check for two items, if they are actually totally same or not
static org.bukkit.inventory.ItemStack	itemFromNBTJson(java.lang.String str) Converts an NBT JSON String to an ItemStack
static boolean	itemSimilar(org.bukkit.inventory.ItemStack item1, org.bukkit.inventory.ItemStack item2) A truth check for two items, if they type is actually totally same or not.
static java.lang.String	itemToNBTJson(org.bukkit.inventory.ItemStack is) Converts an item to NBT Json format
static java.lang.String	itemToString(org.bukkit.inventory.ItemStack in) Converts an ItemStack to it's representing string
static java.lang.String	itemToString(org.bukkit.inventory.ItemStack in, boolean useNBT) Converts an ItemStack to it's representing string with the option to store all NBT tags of the item
static void	loadInv(java.util.Map<java.lang.Integer,org.bukkit.inventory.ItemStack> map, org.bukkit.inventory.Inventory inv) Converts a map representation of a saved inventory to an actual Inventory.
static org.bukkit.inventory.ItemStack	makeItem(org.bukkit.Material type, int amount, short sub, java.lang.String name, java.util.ArrayList<java.lang.String> lore, java.lang.Object... vars)
static org.bukkit.inventory.ItemStack	makeItem(org.bukkit.Material type, int amount, short sub, java.lang.String name, java.lang.String... lore)
static org.bukkit.inventory.ItemStack	makeItem(org.bukkit.Material type, java.lang.String name, java.lang.String... lore)
static int	removeItem(org.bukkit.inventory.Inventory inv, org.bukkit.inventory.ItemStack is) Removes the given item from the given inventory
static java.util.TreeMap<java.lang.Integer,org.bukkit.inventory.ItemStack>	saveInv(org.bukkit.inventory.Inventory inv) Saves an inventory to a TreeMap containing the slots and the items of the given inventory
static org.bukkit.inventory.ItemStack	stringToItemStack(java.lang.String in) Converts an ItemStack representing string back to the ItemStack

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemUtils

public ItemUtils()

Method Detail

addItem

public static int addItem(org.bukkit.inventory.Inventory inv,
                          org.bukkit.inventory.ItemStack is)

Adds the given item to the given inventory with the default max stack size

Parameters:

inv - - The inventory to which the item should be added

is - - The addable item

Returns:

The remaining items after the addition

addItem

public static int addItem(org.bukkit.inventory.Inventory inv,
                          org.bukkit.inventory.ItemStack is,
                          int maxStack)

Adds the given item to the given inventory

Parameters:

inv - - The inventory to which the item should be added

is - - The addable item

maxStack - - Maximal stack size of the item

Returns:

The remaining items after the addition

addLore

public static org.bukkit.inventory.ItemStack addLore(org.bukkit.inventory.ItemStack is,
                                                     java.lang.String... lore)

addLore

public static org.bukkit.inventory.ItemStack addLore(org.bukkit.inventory.ItemStack is,
                                                     java.util.List<java.lang.String> lore,
                                                     java.lang.Object... vars)

addLoreStorageMeta

public static org.bukkit.inventory.ItemStack addLoreStorageMeta(org.bukkit.inventory.ItemStack is,
                                                                java.lang.Object... values)

Adds the given lore storage meta to the given item

Parameters:

is - - Modifiable item

values - - Array of storage format and values

Returns:

The modified item

containsItem

public static boolean containsItem(java.lang.Iterable<org.bukkit.inventory.ItemStack> source,
                                   org.bukkit.inventory.ItemStack is)

A truth check if an iterable contains the given typed item or not

Parameters:

source - ItemStack iterable

is - checked ItemStack

Returns:

True if the ItemStack iterable contains the checked ItemStack in any amount, false otherwise.

countItem

public static int countItem(org.bukkit.inventory.Inventory inv,
                            org.bukkit.inventory.ItemStack is)

Counts the given item in the given inventory

Parameters:

inv - - The inventory in which the item should be counted

is - - The countable item, the amount of the item is ignored (calculated as 1)

Returns:

The amount of the item which is in the inventory

countItemSpace

public static int countItemSpace(org.bukkit.inventory.Inventory inv,
                                 org.bukkit.inventory.ItemStack is,
                                 int maxStack)

Counts the available space for the given item in the given inventory

Parameters:

inv - - The inventory to which the item should be added

is - - The addable item

maxStack - - Maximal stack size of the item

Returns:

The maximum amount

fillVariables

public static org.bukkit.inventory.ItemStack fillVariables(org.bukkit.inventory.ItemStack is,
                                                           java.lang.Object... vars)

Fill variables in a ItemStack Available special variables: #amount: the amount value of the item #id: the id of the item #sub: the subid of the item

Parameters:

is - - The ItemStack in which the variables should be filled

vars - - The fillable variables

Returns:

A clone of the original ItemStack with filled variables

fillVariables

public static org.bukkit.inventory.ItemStack fillVariables(org.bukkit.entity.Player plr,
                                                           org.bukkit.inventory.ItemStack is)

getItem

public static org.bukkit.inventory.ItemStack getItem(java.lang.String name)

Get the numeric id of the given itemname, it works for both numeric and text ids.

Parameters:

name - the case insensitive material name of the item or the numeric id of the item.

Returns:

the numeric id of the requested item or 1, if the given name is incorrect or null

getLoreStorageMeta

public static java.lang.String getLoreStorageMeta(org.bukkit.inventory.ItemStack is,
                                                  java.lang.String format,
                                                  java.lang.String def)

Gets the given lore storage meta from the given ItemStack

Parameters:

is - - The checkable ItemStack

format - - The format of the storage meta

def - - Default value to return if the meta was not found.

Returns:

The first found compatible lore storage meta or def if not found any.

getName

public static java.lang.String getName(org.bukkit.inventory.ItemStack is)

Gets the name of the given item

Parameters:

is - - The item which name we would like to get

Returns:

The name of the item

glow

public static org.bukkit.inventory.ItemStack glow(org.bukkit.inventory.ItemStack item)

Makes item glowing by adding luck 1 enchant to it and hide enchants attribute

Parameters:

item - - The glowable item

Returns:

The glowing item

itemEqual

public static boolean itemEqual(org.bukkit.inventory.ItemStack item1,
                                org.bukkit.inventory.ItemStack item2)

A truth check for two items, if they are actually totally same or not

Parameters:

item1 - first item of the equal checking

item2 - second item of the equal checking

Returns:

True if the two itemstack contains exactly the same abilities (id, count, durability, metadata), false otherwise

itemFromNBTJson

public static org.bukkit.inventory.ItemStack itemFromNBTJson(java.lang.String str)

Converts an NBT JSON String to an ItemStack

Parameters:

str - - Convertable NBT JSON String

Returns:

Conversion result

itemSimilar

public static boolean itemSimilar(org.bukkit.inventory.ItemStack item1,
                                  org.bukkit.inventory.ItemStack item2)

A truth check for two items, if they type is actually totally same or not. The only allowed difference between the stacks could be only their count.

Parameters:

item1 - first item of the similiar checking

item2 - second item of the similiar checking

Returns:

True if the two itemstack contains exactly the same abilities (id, durability, metadata), the item counts could be different; false otherwise.

itemToNBTJson

public static java.lang.String itemToNBTJson(org.bukkit.inventory.ItemStack is)

Converts an item to NBT Json format

Parameters:

is - - Convertable item

Returns:

Conversion result

itemToString

public static java.lang.String itemToString(org.bukkit.inventory.ItemStack in)

Converts an ItemStack to it's representing string

Parameters:

in - convertable ItemStack

Returns:

the conversion output String or "0:-1 0" if the given ItemStack is null

itemToString

public static java.lang.String itemToString(org.bukkit.inventory.ItemStack in,
                                            boolean useNBT)

Converts an ItemStack to it's representing string with the option to store all NBT tags of the item

Parameters:

in - - The convertable ItemStack

useNBT - - Store every nbt tag of the item

Returns:

The conversion output String or "0:-1 0" if the given ItemStack is null

loadInv

public static void loadInv(java.util.Map<java.lang.Integer,org.bukkit.inventory.ItemStack> map,
                           org.bukkit.inventory.Inventory inv)

Converts a map representation of a saved inventory to an actual Inventory. Completely overrides all the existing items in the inventory.

Parameters:

map - - The map containing the items and their slots of the saved inventory

makeItem

public static org.bukkit.inventory.ItemStack makeItem(org.bukkit.Material type,
                                                      int amount,
                                                      short sub,
                                                      java.lang.String name,
                                                      java.lang.String... lore)

makeItem

public static org.bukkit.inventory.ItemStack makeItem(org.bukkit.Material type,
                                                      java.lang.String name,
                                                      java.lang.String... lore)

makeItem

public static org.bukkit.inventory.ItemStack makeItem(org.bukkit.Material type,
                                                      int amount,
                                                      short sub,
                                                      java.lang.String name,
                                                      java.util.ArrayList<java.lang.String> lore,
                                                      java.lang.Object... vars)

removeItem

public static int removeItem(org.bukkit.inventory.Inventory inv,
                             org.bukkit.inventory.ItemStack is)

Removes the given item from the given inventory

Parameters:

inv - - The inventory from which the item should be removed

is - - The removable item

Returns:

The remaining amount of the removable item

saveInv

public static java.util.TreeMap<java.lang.Integer,org.bukkit.inventory.ItemStack> saveInv(org.bukkit.inventory.Inventory inv)

Saves an inventory to a TreeMap containing the slots and the items of the given inventory

Parameters:

inv - - The saveable inventory

Returns:

The saving result

stringToItemStack

public static org.bukkit.inventory.ItemStack stringToItemStack(java.lang.String in)

Converts an ItemStack representing string back to the ItemStack

Parameters:

in - string represantation of an ItemStack

Returns:

The conversion output ItemStack, or null if the given string is null