com.elikill58.negativity.api.inventory

Class Inventory

java.lang.Object

com.elikill58.negativity.api.inventory.Inventory

All Implemented Interfaces:

NegativityObject

Direct Known Subclasses:

PlayerInventory

public abstract class Inventory
extends Object
implements NegativityObject

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_MENU
static String	BAN_MANAGER_MENU
static String	CHEAT_MANAGER
static ItemStack	DYE_GRAY
static ItemStack	DYE_GREEN
static ItemStack	EMPTY
static ItemStack	EMPTY_RED
static String	NAME_ACTIVED_CHEAT_MENU
static String	NAME_CHECK_MENU
static String	NAME_FORGE_MOD_MENU
static String	NAME_FREEZE_MENU
static String	NAME_MOD_MENU
static String	SPECIAL_MANAGER

Constructor Summary

Constructors

Constructor and Description
Inventory()

Method Summary

Modifier and Type	Method and Description
abstract void	addItem(ItemStack build) Add an item at the first available slot
abstract void	clear() Remove all content of the inventory
abstract boolean	contains(Material type) Check if the current inventory contains at least one item with this material
static Inventory	createInventory(String inventoryName, int size, NegativityHolder holder) Create an inventory according to the specific platform
abstract @Nullable ItemStack	get(int slot) Get the item in the inventory at the given slot
static ItemStack	getBackItem(Player p)
static ItemStack	getCloseItem(Player p)
abstract @Nullable PlatformHolder	getHolder() Get the platform holder.
abstract String	getInventoryName() Get the inventory name
abstract int	getSize() Get the size of the inventory
abstract InventoryType	getType() Get the inventory type
abstract void	remove(int slot) Remove item at the given slot (Can also be used if you set a null item at the given slot)
abstract void	set(int slot, ItemStack item) Set a new item to the given slot

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.elikill58.negativity.api.NegativityObject

getDefault

Field Detail

NAME_CHECK_MENU

public static final String NAME_CHECK_MENU

See Also:

Constant Field Values

ADMIN_MENU

public static final String ADMIN_MENU

See Also:

Constant Field Values

NAME_ACTIVED_CHEAT_MENU

public static final String NAME_ACTIVED_CHEAT_MENU

NAME_FREEZE_MENU

public static final String NAME_FREEZE_MENU

See Also:

Constant Field Values

BAN_MANAGER_MENU

public static final String BAN_MANAGER_MENU

See Also:

Constant Field Values

NAME_MOD_MENU

public static final String NAME_MOD_MENU

See Also:

Constant Field Values

CHEAT_MANAGER

public static final String CHEAT_MANAGER

See Also:

Constant Field Values

SPECIAL_MANAGER

public static final String SPECIAL_MANAGER

See Also:

Constant Field Values

NAME_FORGE_MOD_MENU

public static final String NAME_FORGE_MOD_MENU

See Also:

Constant Field Values

EMPTY

public static final ItemStack EMPTY

EMPTY_RED

public static final ItemStack EMPTY_RED

DYE_GRAY

public static final ItemStack DYE_GRAY

DYE_GREEN

public static final ItemStack DYE_GREEN

Constructor Detail

Inventory

public Inventory()

Method Detail

getType

public abstract InventoryType getType()

Get the inventory type

Returns:

the inventory type

get

public abstract @Nullable ItemStack get(int slot)

Get the item in the inventory at the given slot

Parameters:

slot - the slot where we will search the item

Returns:

the item at the given slot

set

public abstract void set(int slot,
                         ItemStack item)

Set a new item to the given slot

Parameters:

slot - the slot of the item

item - the new item

remove

public abstract void remove(int slot)

Remove item at the given slot (Can also be used if you set a null item at the given slot)

Parameters:

slot - the removed item slot

clear

public abstract void clear()

Remove all content of the inventory

addItem

public abstract void addItem(ItemStack build)

Add an item at the first available slot

Parameters:

build - the new item

contains

public abstract boolean contains(Material type)

Check if the current inventory contains at least one item with this material

Parameters:

type - the search type

Returns:

true if found at least one

getSize

public abstract int getSize()

Get the size of the inventory

Returns:

the inventory size

getInventoryName

public abstract String getInventoryName()

Get the inventory name

Returns:

the inventory name

getHolder

public abstract @Nullable PlatformHolder getHolder()

Get the platform holder. The platform holder can be just correspond to a platform one Or can be an NegativityHolder if it's a Negativity inventory.

Returns:

the inventory holder

createInventory

public static Inventory createInventory(String inventoryName,
                                        int size,
                                        NegativityHolder holder)

Create an inventory according to the specific platform

Parameters:

inventoryName - the name of the inventory

size - the size of the inventory

holder - the negativity holder that will be applied to the inventory

Returns:

the new inventory

getCloseItem

public static ItemStack getCloseItem(Player p)

getBackItem

public static ItemStack getBackItem(Player p)