net.risingworld.api.objects

Interface Storage

All Known Subinterfaces:

Chest

public interface Storage

Represents a storage. Storages are not necessarily objects (i.e. chests or crates in the world), instead this is just an abstract representation for all kind of storages (for example, it could also be the content of a mounts saddle bag).

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the chest, i.e. removes all items.
int	getHashCode() Gets a hashcode of this chest.
int	getID() Gets the global, unique ID of this chest.
Item	getItem(int slot) Gets the item from the specified slot.
Item[]	getItems() Gets an array containing all items that are currently in the chest.
int	getSlotCount() Gets the amount of slots the chest has.
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) to the chest (into the next free slot).
Item	insertNewClothingItem(short clothingID, int variation, int color1, int color2, int color3, int slot) Creates and inserts a new "clothes" item (which repreasents a piece of clothes) to the chest (into the particular slot).
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) Creates and inserts a new custom item (which was declared and registered previously) into the particular slot in the chest.
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) 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 free slot.
Item	insertNewObjectItem(short objectID, int variation, int stacksize, int slot) Creates and inserts a new "objectkit" item into the particular slot.
void	removeItem(int slot) Removes an item from a particular slot in the chest.
void	removeItem(int slot, 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 chest.
int	removeItem(short itemID, int variation, int amount) Removes the next item with the given type id and variation from the chest (more precisely, the stack size of the item is reduced by the provided amount).
void	setSlotCount(int slots) Overrides the amount of slots the chest has.

Method Detail

getID

int getID()

Gets the global, unique ID of this chest.

Returns:

the unique chest ID.

getHashCode

int getHashCode()

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

Returns:

the hashcode of this chest.

getSlotCount

int getSlotCount()

Gets the amount of slots the chest has.

Returns:

the total amount of slots.

setSlotCount

void setSlotCount(int slots)

Overrides the amount of slots the chest has. Please note that this changes the max amount of slots permanently for this particular chest! Also keep in mind that reducing the amount of slots could make certain items inaccessible for existing chests (e.g. if slot 100 already contains an item, but you reduce the slot count to 10, the item is no longer accessible and will be removed eventually).

Parameters:

slots - the new slot count. Must be greater than 0 and less or equal than 480 (10 "pages"). Every chest "page" has 48 slots.

Example: Increase chest size to 480 slots (10 pages)

1	Chest chest = world.getChest(...);
2	chest.setSlotCount(480);

getItems

Item[] getItems()

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

Returns:

an array containing all items in the chest.

getItem

Item getItem(int slot)

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

Parameters:

slot - the slot.

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 chest, and this item could be added to its stack, this will be done. Otherwise this item will be added to the next appropriate slot.

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.

Returns:

the newly created item, or if it was added to the stack of an existing item, this item will be returned instead. Returns null if the item could not be added to the chest (e.g. when the chest is full).

insertNewItem

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

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.

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

Returns:

the newly created item, or 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 chest.

insertNewObjectItem

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

Creates and inserts a new "objectkit" item into the next free 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.

Returns:

the newly created item, or 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 chest.

insertNewObjectItem

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

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.

Returns:

the newly created item, or 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 chest.

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) to the chest (into the next free slot). Clothes cannot be stacked, so this function always adds a single "clothes" item.

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 chest.

insertNewClothingItem

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

Creates and inserts a new "clothes" item (which repreasents a piece of clothes) to the chest (into the particular slot). Clothes cannot be stacked, so this function always adds a single "clothes" item.

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.

Returns:

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

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 chest.

insertNewCustomItem

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

Creates and inserts a new custom item (which was declared and registered previously) into the particular slot in the chest. 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 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 chest.

removeItem

void removeItem(int slot)

Removes an item from a particular slot in the chest. 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.

removeItem

void removeItem(int slot,
                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 chest.

Parameters:

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

amount - the amount you want to remove.

removeItem

int removeItem(short itemID,
               int variation,
               int amount)

Removes the next item with the given type id and variation from the chest (more precisely, the stack size of the item is reduced by the provided amount). If the item stack size is smaller than amount, the rest will be removed from the next item. If amount is -1, all items with this id and variation will be removed.

Parameters:

itemID - the item type id.

variation - the item variation (e.g. block texture), usually 0.

amount - the amount you want to remove. Set -1 to remove all items of this type.

Returns:

the rest, or 0 if all items were removed successfully.

Example: Remove 40 gold ingots from chest

1	//Get item definition of gold ingots
2	Definitions.ItemDefinition itemDef = Definitions.getItemDefinition("goldingot");
3
4	//Get the chest you want to remove the items from
5	Chest chest = getWorld().getChest(...);
6
7	//Remove 40 ingots and check if all items were removed successfully
8	int rest = chest.removeItem(itemDef.getID(), 0, 40);
9
10	//If rest > 0, there were not enough gold ingots in this chest
11	if(rest > 0){
12	System.out.println("Not enough ingots in this chest, missing " + rest + " ingots!");
13	}

clear

void clear()

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