ru.abstractmenus.api.inventory

Interface Item

All Superinterfaces:

java.lang.Cloneable

public interface Item
extends java.lang.Cloneable

Represent buildable ItemStack

Method Summary

Modifier and Type	Method and Description
void	addProperty(java.lang.String key, ItemProperty property) Add some property for this item
org.bukkit.inventory.ItemStack	build(org.bukkit.entity.Player player, Menu menu) Build ItemStack of this item
Item	clone() Clone this item
java.util.Map<java.lang.String,ItemProperty>	getProperties() Get properties if the item
boolean	isSimilar(org.bukkit.inventory.ItemStack item, org.bukkit.entity.Player player) Check is this item similar to som ItemStack
ItemProperty	removeProperty(java.lang.String key) Remove property from item
void	setProperties(java.util.Map<java.lang.String,ItemProperty> properties) Set new or replace all properties for this item

Method Detail

getProperties

java.util.Map<java.lang.String,ItemProperty> getProperties()

Get properties if the item

Returns:

List of item properties

addProperty

void addProperty(java.lang.String key,
                 ItemProperty property)

Add some property for this item

Parameters:

key - Property key

property - Item property

setProperties

void setProperties(java.util.Map<java.lang.String,ItemProperty> properties)

Set new or replace all properties for this item

Parameters:

properties - Properties map

removeProperty

ItemProperty removeProperty(java.lang.String key)

Remove property from item

Parameters:

key - Key (name) of the property. This key you specify in item block in menu file

Returns:

Removed property or null if property with specified key is not assigned to item

isSimilar

boolean isSimilar(org.bukkit.inventory.ItemStack item,
                  org.bukkit.entity.Player player)

Check is this item similar to som ItemStack

Parameters:

item - Bukkit ItemStack

player - Player to replace placeholders

Returns:

true if this item similar to provided or false otherwise

build

org.bukkit.inventory.ItemStack build(org.bukkit.entity.Player player,
                                     Menu menu)

Build ItemStack of this item

Parameters:

player - Player to correct replace all placeholders

menu - Menu in which this item exists. Might be null

Returns:

Built ItemStack object

clone

Item clone()

Clone this item

Returns:

Cloned item