li.cil.oc.api.internal

Interface Database

public interface Database

This interface is implemented by the database component.

This allows getting actual item stack instances as referenced by callers of other components' callbacks, without having to push a full representation of an item stacks' NBT data to the VM (which can be both a memory and a security issue).

To use this, you'll usually want to accept an address and either an index or a hash in your component's callback function, the address being that of a database component in the same network as your component. Alternatively you can omit requiring an address and just loop through the other nodes on the network to look for one those that have a Database as host.

Method Summary

Modifier and Type	Method and Description
int	findStackWithHash(java.lang.String hash) Get an item stack with the specified hash stored in this database.
net.minecraft.item.ItemStack	getStackInSlot(int slot) Get an item stack stored in the specified slot of this database.
void	setStackInSlot(int slot, net.minecraft.item.ItemStack stack) Set the contents of a slot in the database upgrade.
int	size() The number of slots in this database.

Method Detail

size

int size()

The number of slots in this database.

getStackInSlot

net.minecraft.item.ItemStack getStackInSlot(int slot)

Get an item stack stored in the specified slot of this database.

This will return null if there is no entry for the specified slot. If there is an entry, this will return a copy of that item stack, so it is safe to modify the returned stack.

Parameters:

slot - the slot of the item stack.

Returns:

the item stack stored in that slot.

setStackInSlot

void setStackInSlot(int slot,
                    net.minecraft.item.ItemStack stack)

Set the contents of a slot in the database upgrade.

Use this to change the configuration of a database upgrade.

Parameters:

slot - the slot to configure.

stack - the stack to configure the slot to, null to clear.

findStackWithHash

int findStackWithHash(java.lang.String hash)

Get an item stack with the specified hash stored in this database.

This will return a negative value if there is no entry with a matching hash.

Parameters:

hash - the hash of the item stack.

Returns:

the index of item stack with the specified hash.