net.malisis.core.inventory

Class MalisisSlot

java.lang.Object

net.malisis.core.inventory.MalisisSlot

Direct Known Subclasses:

PlayerInventorySlot

public class MalisisSlot
extends java.lang.Object

Slots contained by MalisisInventory

Field Summary

Fields

Modifier and Type	Field and Description
int	slotNumber Slot position within its MalisisInventory.
protected InventoryState	state InventoryState of this slot.

Constructor Summary

Constructors

Constructor and Description
MalisisSlot(int index) Instantiates a new MalisisSlot
MalisisSlot(MalisisInventory inventory, int index) Instantiates a new MalisisSlot
MalisisSlot(MalisisInventory inventory, net.minecraft.item.ItemStack itemStack, int index) Instantiates a new MalisisSlot.

Method Summary

Modifier and Type	Method and Description
int	addItemStackSize(int stackSize) Adds the item stack size.
void	clearCache(net.minecraft.entity.player.EntityPlayer player) Clear cache for the EntityPlayer.
net.minecraft.item.ItemStack	extract(int amount) Extract a specified amount from this MalisisSlot.
net.minecraft.item.ItemStack	getDraggedItemStack() Gets the dragged item stack.
MalisisInventory	getInventory() Gets the MalisisInventory of this MalisisSlot.
int	getInventoryId() Gets the id of the MalisisInventory of this MalisisSlot inside the MalisisInventoryContainer.
net.minecraft.item.ItemStack	getItemStack() Gets the item stack.
int	getSlotStackLimit() Gets the maximum stackSize available for this slot.
boolean	hasChanged(net.minecraft.entity.player.EntityPlayer player) Checks whether this slot has changed for the EntityPlayer.
net.minecraft.item.ItemStack	insert(net.minecraft.item.ItemStack insert) Inserts an ItemStack into this MalisisSlot.
net.minecraft.item.ItemStack	insert(net.minecraft.item.ItemStack insert, int amount) Inserts a specified amount of ItemStack into this MalisisSlot.
net.minecraft.item.ItemStack	insert(net.minecraft.item.ItemStack insert, int amount, boolean force) Inserts a specified amount of ItemStack into this MalisisSlot.
boolean	isEmpty() Checks if this MalisisSlot is empty.
boolean	isFull() Checks if this MalisisSlot can accept more itemStack.
boolean	isItemValid(net.minecraft.item.ItemStack itemStack) Checks if this MalisisSlot can contain itemStack.
boolean	isOutputSlot() Checks whether this MalisisSlot is an output slot (if state denies inserts)
boolean	isState(int state) Checks whether this MalisisSlot is allowed for the state.
void	onPickupFromSlot(net.minecraft.entity.player.EntityPlayer player, net.minecraft.item.ItemStack itemStack) Called when itemStack is picked up from this MalisisSlot.
void	onSlotChanged() Called when itemStack is set.
void	register(java.lang.Object object) Registers an object to inventory changes.
void	setDraggedItemStack(net.minecraft.item.ItemStack itemStack) Sets the currently dragged ItemStack for this MalisisSlot.
void	setInventory(MalisisInventory inventory) Sets the inventory containing this MalisisSlot.
void	setItemStack(net.minecraft.item.ItemStack itemStack) Sets the itemStack contained by this MalisisSlot.
int	setItemStackSize(int stackSize) Sets the item stack size.
void	setOutputSlot() Sets this MalisisSlot as an output slot.
java.lang.String	toString()
void	updateCache(net.minecraft.entity.player.EntityPlayer player) Update the cached itemStacks of this MalisisSlot for the EntityPlayer.

Methods inherited from class java.lang.Object

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

Field Detail

slotNumber

public int slotNumber

Slot position within its MalisisInventory.

state

protected InventoryState state

InventoryState of this slot.

Constructor Detail

MalisisSlot

public MalisisSlot(MalisisInventory inventory,
                   net.minecraft.item.ItemStack itemStack,
                   int index)

Instantiates a new MalisisSlot.

Parameters:

inventory - the inventory

itemStack - the item stack

index - the index

MalisisSlot

public MalisisSlot(MalisisInventory inventory,
                   int index)

Instantiates a new MalisisSlot

Parameters:

inventory - the inventory

index - the index

MalisisSlot

public MalisisSlot(int index)

Instantiates a new MalisisSlot

Parameters:

index - the index

Method Detail

register

public void register(java.lang.Object object)

Registers an object to inventory changes.

Parameters:

object - the object

setInventory

public void setInventory(MalisisInventory inventory)

Sets the inventory containing this MalisisSlot.

Parameters:

inventory - the new inventory

getInventory

public MalisisInventory getInventory()

Gets the MalisisInventory of this MalisisSlot.

Returns:

the inventory

getInventoryId

public int getInventoryId()

Gets the id of the MalisisInventory of this MalisisSlot inside the MalisisInventoryContainer.

Returns:

the inventory id

setItemStack

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

Sets the itemStack contained by this MalisisSlot. Does not check for slot validity, max stack size etc...

Parameters:

itemStack - the new item stack

getItemStack

public net.minecraft.item.ItemStack getItemStack()

Gets the item stack.

Returns:

the itemStack contained by this MalisisSlot.

setDraggedItemStack

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

Sets the currently dragged ItemStack for this MalisisSlot.

Parameters:

itemStack - the new dragged item stack

getDraggedItemStack

public net.minecraft.item.ItemStack getDraggedItemStack()

Gets the dragged item stack.

Returns:

the currently dragged ItemStack for this MalisisSlot

setOutputSlot

public void setOutputSlot()

Sets this MalisisSlot as an output slot. Sets the slot state to deny inserts.

isOutputSlot

public boolean isOutputSlot()

Checks whether this MalisisSlot is an output slot (if state denies inserts)

Returns:

true if is output slot, false otherwise

isState

public boolean isState(int state)

Checks whether this MalisisSlot is allowed for the state.

Parameters:

state - the state

Returns:

true if both the MalisisInventory and this MalisisSlot allow the state, false otherwise.

isItemValid

public boolean isItemValid(net.minecraft.item.ItemStack itemStack)

Checks if this MalisisSlot can contain itemStack. Defers the test to this inventory.

Parameters:

itemStack - the item stack

Returns:

true if the itemStack can be container in this MalisisSlot

isFull

public boolean isFull()

Checks if this MalisisSlot can accept more itemStack.

Returns:

true, if is full

isEmpty

public boolean isEmpty()

Checks if this MalisisSlot is empty.

Returns:

true, if is empty

onSlotChanged

public void onSlotChanged()

Called when itemStack is set.

onPickupFromSlot

public void onPickupFromSlot(net.minecraft.entity.player.EntityPlayer player,
                             net.minecraft.item.ItemStack itemStack)

Called when itemStack is picked up from this MalisisSlot.

Parameters:

player - the player

itemStack - the item stack

setItemStackSize

public int setItemStackSize(int stackSize)

Sets the item stack size.

Parameters:

stackSize - the stack size

Returns:

the amount of items that were added to the slot.

addItemStackSize

public int addItemStackSize(int stackSize)

Adds the item stack size.

Parameters:

stackSize - the stack size

Returns:

the amount of items that were added to the slot

extract

public net.minecraft.item.ItemStack extract(int amount)

Extract a specified amount from this MalisisSlot.

Parameters:

amount - the amount

Returns:

the ItemStack extracted

insert

public net.minecraft.item.ItemStack insert(net.minecraft.item.ItemStack insert)

Inserts an ItemStack into this MalisisSlot.

Parameters:

insert - the itemStack to insert

Returns:

the itemStack that couldn't fit into the slot

insert

public net.minecraft.item.ItemStack insert(net.minecraft.item.ItemStack insert,
                                           int amount)

Inserts a specified amount of ItemStack into this MalisisSlot.

Parameters:

insert - the itemStack to insert

amount - the amount to insert

Returns:

the itemStack that couldn't fit into the slot

insert

public net.minecraft.item.ItemStack insert(net.minecraft.item.ItemStack insert,
                                           int amount,
                                           boolean force)

Inserts a specified amount of ItemStack into this MalisisSlot.
If force is true, the current ItemStack in the slot will be replaced if it cannot be merged.

Parameters:

insert - the itemStack to insert

amount - the amount to insert

force - whether the itemStack should be forced in the slot

Returns:

the itemStack that couldn't fit into the slot

getSlotStackLimit

public int getSlotStackLimit()

Gets the maximum stackSize available for this slot. Gets the value from this inventory.

Returns:

the slot stack limit.

hasChanged

public boolean hasChanged(net.minecraft.entity.player.EntityPlayer player)

Checks whether this slot has changed for the EntityPlayer.

Parameters:

player - the player

Returns:

true, if changed, false otherwise

updateCache

public void updateCache(net.minecraft.entity.player.EntityPlayer player)

Update the cached itemStacks of this MalisisSlot for the EntityPlayer.

Parameters:

player - the player

clearCache

public void clearCache(net.minecraft.entity.player.EntityPlayer player)

Clear cache for the EntityPlayer.

Parameters:

player - the player

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object