net.tridentsdk.inventory

Interface Inventory

All Known Implementing Classes:

TridentInventory

@ThreadSafe
public interface Inventory

Represents an inventory or inventory that is opened to players

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Method Summary

Modifier and Type	Method and Description
int	id() Obtains the ID of the inventory
Item	itemAt(int slot) Finds the item at the specified slot in the inventory
Item[]	items() Obtains the contents of the inventory represented by this inventory
int	length() The available slots (not the slots taken up) in this inventory
String	name() The title of the inventory
boolean	putItem(Item item) Places an item into the player's inventory, where there is room
void	setSlot(int index, Item value) Sets the item at the slot.

Method Detail

id

int id()

Obtains the ID of the inventory

Returns:

the inventory ID of this inventory

length

int length()

The available slots (not the slots taken up) in this inventory

Returns:

the inventory slots available

itemAt

Item itemAt(int slot)

Finds the item at the specified slot in the inventory

Parameters:

slot - the slot to find the item

Returns:

the item at that slot

setSlot

void setSlot(int index,
             Item value)

Sets the item at the slot. If the index is outside the bound, the effects are unspecified.

Parameters:

index - the index which to set the item at

value - the item to set at the index

putItem

boolean putItem(Item item)

Places an item into the player's inventory, where there is room

Parameters:

item - the item to place

Returns:

True if managed to place an item, false if failed

name

String name()

The title of the inventory

Returns:

the name displayed at the top of the inventory

items

Item[] items()

Obtains the contents of the inventory represented by this inventory

Returns:

the items in the inventory