net.malisis.core.inventory

Class MalisisInventory

java.lang.Object

net.malisis.core.inventory.MalisisInventory

Direct Known Subclasses:

PlayerInventory

public class MalisisInventory
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<MalisisInventoryContainer>	containers List of MalisisInventory that is currently containing this MalisisInventory.
protected int	inventoryId The inventory id inside the container.
protected IInventoryProvider	inventoryProvider Object containing this MalisisInventory.
protected net.minecraft.item.ItemStack	itemStackProvider ItemStack holding the inventory when inventoryProvider is an Item.
protected java.lang.String	name Name of this MalisisInventory.
protected int	size Number of slots inside this MalisisInventory.
protected int	slotMaxStackSize Maximum stack size for the slots.
protected MalisisSlot[]	slots Slots for this MalisisInventory.
InventoryState	state Current inventory state.

Constructor Summary

Constructors

Constructor and Description
MalisisInventory(IInventoryProvider provider, int size) Instantiates a new MalisisInventory.
MalisisInventory(IInventoryProvider provider, MalisisSlot... slots) Instantiates a new MalisisInventory.

Method Summary

Modifier and Type	Method and Description
void	addOpenedContainer(MalisisInventoryContainer container) Adds the opened container.
void	breakInventory(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Spills out all the itemStack contained inside this MalisisInventory.
void	closeContainers() Closes all currently opened containers
void	emptyInventory() Empties this MalisisInventory and sets all slots contents to null.
MalisisSlot	getFirstOccupiedSlot() Gets the first MalisisSlot containing an ItemStack.
int	getInventoryId() Gets the id of this MalisisInventory inside the MalisisInventoryContainer.
int	getInventoryStackLimit() Gets the inventory stack limit.
net.minecraft.item.ItemStack	getItemStack(int slotNumber) Gets the itemStack from the slot at position slotNumber.
java.util.List<net.minecraft.item.ItemStack>	getItemStackList() Gets the item stack list.
java.lang.String	getName() Gets this MalisisInventory name.
java.util.Set<MalisisInventoryContainer>	getOpenedContainers() Gets the opened containers.
IInventoryProvider	getProvider() Gets the IInventoryProvider of this MalisisInventory.
int	getSizeInventory() Gets the size inventory.
MalisisSlot	getSlot(int slotNumber) Gets the slot at position slotNumber.
MalisisSlot[]	getSlots() Gets the slots.
boolean	hasCustomName() Checks if this MalisisInventory has a name set.
boolean	isEmpty() Checks if at least one itemStack is present in inventory.
boolean	isFull() Checks if at least one slot is not full.
boolean	isItemValidForSlot(int slotNumber, net.minecraft.item.ItemStack itemStack) Checks whether itemStack can be contained by the slot at position slotNumber.
boolean	itemValidForSlot(MalisisSlot slot, net.minecraft.item.ItemStack itemStack) Checks whether itemStack can be contained by slot.
void	onSlotChanged(MalisisSlot slot) Called when itemStack change in slot.
static <T> MalisisInventoryContainer	open(net.minecraft.entity.player.EntityPlayerMP player, IInventoryProvider.IDeferredInventoryProvider<T> inventoryProvider, T data) Opens this MalisisInventory.
static MalisisInventoryContainer	open(net.minecraft.entity.player.EntityPlayerMP player, IInventoryProvider.IDirectInventoryProvider inventoryProvider) Opens this MalisisInventory.
static <T> MalisisInventoryContainer	open(net.minecraft.client.entity.EntityPlayerSP player, IInventoryProvider.IDeferredInventoryProvider<T> inventoryProvider, T data, int windowId) Opens this MalisisInventory.
static MalisisInventoryContainer	open(net.minecraft.client.entity.EntityPlayerSP player, IInventoryProvider.IDirectInventoryProvider inventoryProvider, int windowId) Opens this MalisisInventory.
void	overrideSlot(MalisisSlot slot, int slotNumber) Overrides a specific slot with a new one.
net.minecraft.item.ItemStack	pullItemStack() Removes the first ItemStack in this MalisisInventory and returns it.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound tagCompound) Reads this MalisisInventory data from tagCompound.
void	register(java.lang.Object object) Registers an object for the events fired by this MalisisInventory.
void	removeOpenedContainer(MalisisInventoryContainer container) Removes the opened container.
void	setInventoryId(int id) Sets the id of this MalisisInventory inside its container.
void	setInventoryStackLimit(int limit) Sets the inventory stack limit.
void	setItemStack(int slotNumber, net.minecraft.item.ItemStack itemStack) Sets the itemStack for the slot at position slotNumber.
void	setItemStackProvider(net.minecraft.item.ItemStack itemStack) Set this MalisisInventory contents based on the itemStack NBT.
void	setName(java.lang.String name) Sets this MalisisInventory name.
void	setSlots(MalisisSlot[] slots) Sets the slots for this MalisisInventory.
java.lang.String	toString()
void	transfer(MalisisInventory inventory) Transfers into this MalisisInventory the contents of inventory.
net.minecraft.item.ItemStack	transferInto(net.minecraft.item.ItemStack itemStack) Transfers an ItemStack inside this MalisisInventory.
net.minecraft.item.ItemStack	transferInto(net.minecraft.item.ItemStack itemStack, boolean reversed) Transfers itemStack inside this MalisisInventory.
protected net.minecraft.item.ItemStack	transferInto(net.minecraft.item.ItemStack itemStack, boolean emptySlot, int start, int end) Transfers itemStack inside this MalisisInventory into slots at position from start to end.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound tagCompound) Writes this MalisisInventory data inside tagCompound.

Methods inherited from class java.lang.Object

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

Field Detail

containers

protected java.util.Set<MalisisInventoryContainer> containers

List of MalisisInventory that is currently containing this MalisisInventory.

inventoryId

protected int inventoryId

The inventory id inside the container.

inventoryProvider

protected IInventoryProvider inventoryProvider

Object containing this MalisisInventory.

itemStackProvider

protected net.minecraft.item.ItemStack itemStackProvider

ItemStack holding the inventory when inventoryProvider is an Item.

slots

protected MalisisSlot[] slots

Slots for this MalisisInventory.

name

protected java.lang.String name

Name of this MalisisInventory.

size

protected int size

Number of slots inside this MalisisInventory.

slotMaxStackSize

protected int slotMaxStackSize

Maximum stack size for the slots.

state

public InventoryState state

Current inventory state.

Constructor Detail

MalisisInventory

public MalisisInventory(IInventoryProvider provider,
                        int size)

Instantiates a new MalisisInventory.

Parameters:

provider - the provider

size - the size

MalisisInventory

public MalisisInventory(IInventoryProvider provider,
                        MalisisSlot... slots)

Instantiates a new MalisisInventory.

Parameters:

provider - the provider

slots - the slots

Method Detail

getProvider

public IInventoryProvider getProvider()

Gets the IInventoryProvider of this MalisisInventory.

Returns:

the provider.

setSlots

public void setSlots(MalisisSlot[] slots)

Sets the slots for this MalisisInventory.

Parameters:

slots - the new slots

overrideSlot

public void overrideSlot(MalisisSlot slot,
                         int slotNumber)

Overrides a specific slot with a new one.

Parameters:

slot - the slot

slotNumber - the slot number

register

public void register(java.lang.Object object)

Registers an object for the events fired by this MalisisInventory.

Parameters:

object - the object

setInventoryId

public void setInventoryId(int id)

Sets the id of this MalisisInventory inside its container.

Parameters:

id - the new inventory id

getInventoryId

public int getInventoryId()

Gets the id of this MalisisInventory inside the MalisisInventoryContainer.

Returns:

the inventory id.

setName

public void setName(java.lang.String name)

Sets this MalisisInventory name.

Parameters:

name - the new name

getName

public java.lang.String getName()

Gets this MalisisInventory name.

Returns:

the inventory name

hasCustomName

public boolean hasCustomName()

Checks if this MalisisInventory has a name set.

Returns:

true, if successful

getSlot

public MalisisSlot getSlot(int slotNumber)

Gets the slot at position slotNumber.

Parameters:

slotNumber - the slot number

Returns:

the slot

getSlots

public MalisisSlot[] getSlots()

Gets the slots.

Returns:

all slots from this MalisisInventory.

getItemStack

public net.minecraft.item.ItemStack getItemStack(int slotNumber)

Gets the itemStack from the slot at position slotNumber.

Parameters:

slotNumber - the slot number

Returns:

the item stack

setItemStack

public void setItemStack(int slotNumber,
                         net.minecraft.item.ItemStack itemStack)

Sets the itemStack for the slot at position slotNumber.

Parameters:

slotNumber - the slot number

itemStack - the item stack

getItemStackList

public java.util.List<net.minecraft.item.ItemStack> getItemStackList()

Gets the item stack list.

Returns:

the item stack list

itemValidForSlot

public boolean itemValidForSlot(MalisisSlot slot,
                                net.minecraft.item.ItemStack itemStack)

Checks whether itemStack can be contained by slot.

Parameters:

slot - the slot

itemStack - the item stack

Returns:

true, if successful

isItemValidForSlot

public boolean isItemValidForSlot(int slotNumber,
                                  net.minecraft.item.ItemStack itemStack)

Checks whether itemStack can be contained by the slot at position slotNumber.

Parameters:

slotNumber - the slot number

itemStack - the item stack

Returns:

true, if is item valid for slot

getSizeInventory

public int getSizeInventory()

Gets the size inventory.

Returns:

size of this MalisisInventory.

getInventoryStackLimit

public int getInventoryStackLimit()

Gets the inventory stack limit.

Returns:

stack size limit for the slots

setInventoryStackLimit

public void setInventoryStackLimit(int limit)

Sets the inventory stack limit.

Parameters:

limit - the new inventory stack limit

setItemStackProvider

public void setItemStackProvider(net.minecraft.item.ItemStack itemStack)

Set this MalisisInventory contents based on the itemStack NBT.
The inventoryProvider need to be an Item.

Parameters:

itemStack - the new item stack provider

addOpenedContainer

public void addOpenedContainer(MalisisInventoryContainer container)

Adds the opened container.

Parameters:

container - the container

removeOpenedContainer

public void removeOpenedContainer(MalisisInventoryContainer container)

Removes the opened container.

Parameters:

container - the container

getOpenedContainers

public java.util.Set<MalisisInventoryContainer> getOpenedContainers()

Gets the opened containers.

Returns:

the opened containers

isEmpty

public boolean isEmpty()

Checks if at least one itemStack is present in inventory.

Returns:

true, if is empty

isFull

public boolean isFull()

Checks if at least one slot is not full.

Returns:

true, if is full

onSlotChanged

public void onSlotChanged(MalisisSlot slot)

Called when itemStack change in slot.

Parameters:

slot - the slot

getFirstOccupiedSlot

public MalisisSlot getFirstOccupiedSlot()

Gets the first MalisisSlot containing an ItemStack.

Returns:

the first occupied slot

pullItemStack

public net.minecraft.item.ItemStack pullItemStack()

Removes the first ItemStack in this MalisisInventory and returns it.

Returns:

the item stack

transfer

public void transfer(MalisisInventory inventory)

Transfers into this MalisisInventory the contents of inventory.

Parameters:

inventory - the inventory

transferInto

public net.minecraft.item.ItemStack transferInto(net.minecraft.item.ItemStack itemStack)

Transfers an ItemStack inside this MalisisInventory.

Parameters:

itemStack - the item stack

Returns:

the itemStack that could not fit inside this inventory

transferInto

public net.minecraft.item.ItemStack transferInto(net.minecraft.item.ItemStack itemStack,
                                                 boolean reversed)

Transfers itemStack inside this MalisisInventory.

Parameters:

itemStack - the item stack

reversed - if true, start filling slots from the last slot

Returns:

the itemStack that could not fit inside this inventory

transferInto

protected net.minecraft.item.ItemStack transferInto(net.minecraft.item.ItemStack itemStack,
                                                    boolean emptySlot,
                                                    int start,
                                                    int end)

Transfers itemStack inside this MalisisInventory into slots at position from start to end. If start > end, the slots will be filled backwards.

Parameters:

itemStack - the item stack

emptySlot - whether to fill empty slots only

start - the start

end - the end

Returns:

the itemStack that could not fit inside this inventory

breakInventory

public void breakInventory(net.minecraft.world.World world,
                           net.minecraft.util.math.BlockPos pos)

Spills out all the itemStack contained inside this MalisisInventory.

Parameters:

world - the world

pos - the pos

emptyInventory

public void emptyInventory()

Empties this MalisisInventory and sets all slots contents to null.

closeContainers

public void closeContainers()

Closes all currently opened containers

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound tagCompound)

Reads this MalisisInventory data from tagCompound.

Parameters:

tagCompound - the tag compound

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound tagCompound)

Writes this MalisisInventory data inside tagCompound.

Parameters:

tagCompound - the tag compound

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

open

public static MalisisInventoryContainer open(net.minecraft.entity.player.EntityPlayerMP player,
                                             IInventoryProvider.IDirectInventoryProvider inventoryProvider)

Opens this MalisisInventory. Called server-side only.

Parameters:

player - the player

inventoryProvider - the inventory provider

Returns:

the MalisisInventoryContainer

open

public static <T> MalisisInventoryContainer open(net.minecraft.entity.player.EntityPlayerMP player,
                                                 IInventoryProvider.IDeferredInventoryProvider<T> inventoryProvider,
                                                 T data)

Opens this MalisisInventory. Called server-side only.

Type Parameters:

T - the generic type

Parameters:

player - the player

inventoryProvider - the inventory provider

data - the data

Returns:

the MalisisInventoryContainer

open

public static MalisisInventoryContainer open(net.minecraft.client.entity.EntityPlayerSP player,
                                             IInventoryProvider.IDirectInventoryProvider inventoryProvider,
                                             int windowId)

Opens this MalisisInventory. Called client-side only.

Parameters:

player - the player

inventoryProvider - the inventory provider

windowId - the window id

Returns:

the MalisisInventoryContainer

open

public static <T> MalisisInventoryContainer open(net.minecraft.client.entity.EntityPlayerSP player,
                                                 IInventoryProvider.IDeferredInventoryProvider<T> inventoryProvider,
                                                 T data,
                                                 int windowId)

Opens this MalisisInventory. Called client-side only.

Parameters:

player - the player

inventoryProvider - the inventory provider

windowId - the window id

data - the data

Returns:

the MalisisInventoryContainer