net.risingworld.api.objects

Interface Inventory

public interface Inventory

Represents the inventory of a player or npc. This may also be the inventory of a player who is currently offline.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Inventory.SlotType Determines the "inventory type" or "slot type", i.e. the category in the inventory (regular inventory items, hotbar, equipment etc.)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the inventory, i.e. removes all items.
Item[]	getAllItems() Gets an array containing all items in this inventory.
int	getInventoryHashCode() Gets a hashcode of this inventory.
Item	getItem(int slot, Inventory.SlotType slotType) Gets the item from the specified slot and inventory type.
Item[]	getItems(Inventory.SlotType slotType) Gets an array containing all items that are currently in the particular inventory type.
int	getOwnerID() Gets the ID of the according owner.
int	getPlayerDbID() Deprecated. Inventories are no longer used exclusively for players. Instead they're also used by some npcs. Use getOwnerID() instead!
byte	getQuickslotFocus() Gets the current quickslot (hotbar) focus (i.e. the currently equipped item).
int	getSlotCount(Inventory.SlotType slotType) Gets the amount of slots the particular inventory/slot type has.
Item	insertNewClothingItem(short clothingID, int variation)
Item	insertNewClothingItem(short clothingID, int variation, int color1, int color2, int color3) Creates and inserts a new "clothes" item (which repreasents a piece of clothes) into the next slot that is available.
Item	insertNewClothingItem(short clothingID, int variation, int color1, int color2, int color3, int slot, Inventory.SlotType slotType) Creates and inserts a new "clothes" item (which repreasents a piece of clothes) to the inventory.
Item	insertNewCustomItem(java.lang.String uuid, int variation, int stacksize) Creates and inserts a new custom item (which was declared and registered previously).
Item	insertNewCustomItem(java.lang.String uuid, int variation, int stacksize, int slot, Inventory.SlotType slotType) Creates and inserts a new custom item (which was declared and registered previously) into the particular slot in the inventory.
Item	insertNewItem(short itemID, int variation, int stacksize) Creates and inserts a new item into the next slot that is available.
Item	insertNewItem(short itemID, int variation, int stacksize, int slot, Inventory.SlotType slotType) Creates and inserts a new item into the particular slot.
Item	insertNewObjectItem(short objectID, int variation, int stacksize) Creates and inserts a new "objectkit" item into the next slot that is available.
Item	insertNewObjectItem(short objectID, int variation, int stacksize, int slot, Inventory.SlotType slotType) Creates and inserts a new "objectkit" item into the particular slot.
void	removeItem(int slot, Inventory.SlotType slotType) Removes an item from a particular slot in the inventory.
void	removeItem(int slot, Inventory.SlotType slotType, int amount) Removes an item (or more precisely, reduces the stack size of the item by the provided amount) from a particular slot in the inventory.

Method Detail

getPlayerDbID

int getPlayerDbID()

Deprecated. Inventories are no longer used exclusively for players. Instead they're also used by some npcs. Use getOwnerID() instead!

Gets the database ID of the according player.

Returns:

the database ID of the player this inventory belongs to.

getOwnerID

int getOwnerID()

Gets the ID of the according owner. If this is a player inventory, the player database ID is returned (DbID). If this is the inventory of an npc, the npc ID is returned.

Returns:

the owner id.

getQuickslotFocus

byte getQuickslotFocus()

Gets the current quickslot (hotbar) focus (i.e. the currently equipped item).

Returns:

the number of the currently selected quickslot.

getInventoryHashCode

int getInventoryHashCode()

Gets a hashcode of this inventory. If the content of the inventory changes, the hashcode changes accordingly. Use this value to check if the content of the inventory has changed.

Returns:

the hashcode of this inventory.

getSlotCount

int getSlotCount(Inventory.SlotType slotType)

Gets the amount of slots the particular inventory/slot type has.

Parameters:

slotType - the slot type.

Returns:

the total amount of slots.

getItems

Item[] getItems(Inventory.SlotType slotType)

Gets an array containing all items that are currently in the particular inventory type. Note that the array may also contain null if there is no item in a particular slot.

Parameters:

slotType - the inventory/slot type (i.e. the category) you want to get the items from.

Returns:

an array containing all items in the particular slot type.

getAllItems

Item[] getAllItems()

Gets an array containing all items in this inventory. Note that a new array is always created when calling this function. This array may contain null values, if a particular slot in the inventory does not hold any items.

Returns:

an array containing all items in this inventory.

getItem

Item getItem(int slot,
             Inventory.SlotType slotType)

Gets the item from the specified slot and inventory type. Returns null if there is no item in this slot.

Parameters:

slot - the slot.

slotType - the slot / inventory type.

Returns:

the item in the slot, or null if there is no item in the slot.

insertNewItem

Item insertNewItem(short itemID,
                   int variation,
                   int stacksize)

Creates and inserts a new item into the next slot that is available. If there is an item of the same type in the inventory, and this item could be added to its stack, this will be done. Otherwise this item will be added to the next appropriate slot.

To find the next slot, the game first checks the hotbar/quickslots, then the ammo slots (if this item is an ammo item) or the equipment slots (if this item is an equipment item), and at last the regular inventory slots.

Parameters:

itemID - the item type ID.

variation - the variation/texture of the item (only relevant for blocks etc). Usually the variation for most regular items is 0.

stacksize - the stack size, i.e. the amount of items. This value cannot be higher than the max stack size for an invidivual item.

Returns:

the newly created item. If there was already a compatible item in the target slot, this item will be returned instead. Returns null if the item could not be added to the inventory.

Example: Insert a single block (ID: 60) with texture ID 181 (metal yellow/black stripes) into the inventory

1	Inventory inventory = player.getInventory();
2	Item item = inventory.insertNewItem((short) 60, 181, 1);
3	if(item != null){
4	System.out.println("Item "+item.getName()+" has been added to the inventory");
5	}
6	else{
7	System.out.println("Item could not be added to the inventory!");
8	}

insertNewItem

Item insertNewItem(short itemID,
                   int variation,
                   int stacksize,
                   int slot,
                   Inventory.SlotType slotType)

Creates and inserts a new item into the particular slot. If there is already an item in the slot which is compatible to the new item (i.e. the same item), the new units will be added to the stack (as long as the max stack size is not exceeded). Otherwise, if the item is not compatible to the new item, it will be replaced by the new item.

Parameters:

itemID - the item type ID.

variation - the variation/texture of the item (only relevant for blocks etc). Typically the the variation for most items is 0.

stacksize - the stack size, i.e. the amount of items. This value cannot be higher than the max stack size for an invidivual item.

slot - the target slot where you want to insert the item.

slotType - the target slot type.

Returns:

the newly created item. If there was already a compatible item in the target slot, this item will be returned instead. Returns null if the item could not be added to the inventory.

Example: Insert an item (ID 12) with stacksize of 32 into the first inventory slot

1	Inventory inventory = player.getInventory();
2	Item item = inventory.insertNewItem((short) 12, 0, 32, 0, SlotType.Quickslot);
3	if(item != null){
4	System.out.println("Item "+item.getName()+" has been added to the inventory");
5	}

insertNewObjectItem

Item insertNewObjectItem(short objectID,
                         int variation,
                         int stacksize)

Creates and inserts a new "objectkit" item into the next slot that is available. If there is an item of the same type in the inventory, and this item could be added to its stack, this will be done. Otherwise this item will be added to the next appropriate slot.

To find the next slot, the game first checks the hotbar/quickslots, then the ammo slots (if this item is an ammo item) or the equipment slots (if this item is an equipment item), and at last the regular inventory slots.

Parameters:

objectID - the object type ID.

variation - the object variation (texture). By default 0

stacksize - the stack size, i.e. the amount of items. This value cannot be higher than the max stack size for an invidivual item.

Returns:

the newly created item. If there was already a compatible item in the target slot, this item will be returned instead. Returns null if the item could not be added to the inventory.

insertNewObjectItem

Item insertNewObjectItem(short objectID,
                         int variation,
                         int stacksize,
                         int slot,
                         Inventory.SlotType slotType)

Creates and inserts a new "objectkit" item into the particular slot. If there is already an item in the slot which is compatible to the new item (i.e. the same object), the new units will be added to the stack (as long as the max stack size is not exceeded). Otherwise, if the item is not compatible to the new item, it will be replaced by the new item.

Parameters:

objectID - the object type ID.

variation - the object variation (texture). By default 0

stacksize - the stack size, i.e. the amount of items. This value cannot be higher than the max stack size for an invidivual item.

slot - the target slot where you want to insert the object item.

slotType - the target slot type.

Returns:

the newly created item. If there was already a compatible item in the target slot, this item will be returned instead. Returns null if the item could not be added to the inventory.

insertNewClothingItem

Item insertNewClothingItem(short clothingID,
                           int variation)

insertNewClothingItem

Item insertNewClothingItem(short clothingID,
                           int variation,
                           int color1,
                           int color2,
                           int color3)

Creates and inserts a new "clothes" item (which repreasents a piece of clothes) into the next slot that is available. Clothes cannot be stacked, so this function only adds a single "clothes" item to the inventory.

Parameters:

clothingID - the clothing type ID.

variation - currently not used, set to 0.

color1 - currently not used, set to 0xFFFFFF

color2 - currently not used, set to 0xFFFFFF

color3 - currently not used, set to 0xFFFFFF

Returns:

the newly created item. Returns null if the item could not be added to the inventory.

Example: Add a tux jacket, pants and shoes to the player inventory

1	Inventory = player.getInventory();
2	//Insert tux_jacket (id 32)
3	inventory.insertNewClothingItem((short)32, 0, 0xFFFFFF, 0xFFFFFF, 0xFFFFFF);
4	//Insert tux_pants (id 34)
5	inventory.insertNewClothingItem((short)34, 0, 0xFFFFFF, 0xFFFFFF, 0xFFFFFF);
6	//Insert tux_shoes (id 35)
7	inventory.insertNewClothingItem((short)35, 0, 0xFFFFFF, 0xFFFFFF, 0xFFFFFF);

insertNewClothingItem

Item insertNewClothingItem(short clothingID,
                           int variation,
                           int color1,
                           int color2,
                           int color3,
                           int slot,
                           Inventory.SlotType slotType)

Creates and inserts a new "clothes" item (which repreasents a piece of clothes) to the inventory. Clothes cannot be stacked, so this function only adds a single "clothes" item to the inventory.

Parameters:

clothingID - the clothing type ID.

variation - currently not used, set to 0.

color1 - currently not used, set to 0xFFFFFF

color2 - currently not used, set to 0xFFFFFF

color3 - currently not used, set to 0xFFFFFF

slot - the target slot where you want to insert the item.

slotType - the target slot type.

Returns:

the newly created item. Returns null if the item could not be added to the inventory.

insertNewCustomItem

Item insertNewCustomItem(java.lang.String uuid,
                         int variation,
                         int stacksize)

Creates and inserts a new custom item (which was declared and registered previously). The item is identified by its UUID.

Parameters:

uuid - the custom item UUID (see CustomItem.getUUID())

variation - the (optional) item variation. Default is 0.

stacksize - the amount of items you want to insert. This value cannot be higher than the max stack size that was defined for the custom item.

Returns:

the newly created item. If there was already a compatible item in the target slot, this item will be returned instead. Returns null if the item could not be added to the inventory.

insertNewCustomItem

Item insertNewCustomItem(java.lang.String uuid,
                         int variation,
                         int stacksize,
                         int slot,
                         Inventory.SlotType slotType)

Creates and inserts a new custom item (which was declared and registered previously) into the particular slot in the inventory. The item is identified by its UUID.

Parameters:

uuid - the custom item UUID (see CustomItem.getUUID())

variation - the (optional) item variation. Default is 0.

stacksize - the amount of items you want to insert. This value cannot be higher than the max stack size that was defined for the custom item.

slot - the target slot where you want to insert the custom item.

slotType - the target slot type.

Returns:

the newly created item. If there was already a compatible item in the target slot, this item will be returned instead. Returns null if the item could not be added to the inventory.

Example: Create and insert custom item into first hotbar slot

1	CustomItem customItem = new CustomItme("mycustomuniqueuuid", "masteritem", Type.Item);
2	//Setup custom item (e.g. model, icon, animation etc)
3	//...
4
5	//Register custom item (preferably when the plugin is initialized, e.g. in the onEnable() method)
6	getServer().registerCustomItem(customItem);
7
8	//...
9
10	//Add item to player inventory
11	player.getInventory().insertNewCustomItem("mycustomuniqueuuid", 0, 1, 0, SlotType.Quickslot);

removeItem

void removeItem(int slot,
                Inventory.SlotType slotType)

Removes an item from a particular slot in the inventory. After calling this method, the particular slot does no longer contain an item.

Parameters:

slot - the target slot you want to remove the item from.

slotType - the target slot / inventory type.

removeItem

void removeItem(int slot,
                Inventory.SlotType slotType,
                int amount)

Removes an item (or more precisely, reduces the stack size of the item by the provided amount) from a particular slot in the inventory.

Parameters:

slot - the target slot you want to remove the item from.

slotType - the target slot / inventory type.

amount - the amount you want to remove.

clear

void clear()

Clears the inventory, i.e. removes all items.