Package alexiil.mc.lib.attributes.item.impl

Class SimpleLimitedFixedItemInv

java.lang.Object

alexiil.mc.lib.attributes.item.impl.DelegatingFixedItemInv

alexiil.mc.lib.attributes.item.impl.SimpleLimitedFixedItemInv

All Implemented Interfaces:

Convertible, AbstractItemInvView, FixedItemInv, FixedItemInvView, LimitedFixedItemInv

Direct Known Subclasses:

SimpleLimitedFixedItemInv.OfCopying, SimpleLimitedFixedItemInv.OfModifiable

public class SimpleLimitedFixedItemInv
extends DelegatingFixedItemInv
implements LimitedFixedItemInv

A simple implementation of LimitedFixedItemInv that makes no assumptions about the backing FixedItemInv.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleLimitedFixedItemInv.OfCopying
static class	SimpleLimitedFixedItemInv.OfModifiable

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.item.AbstractItemInvView

AbstractItemInvView.DefaultChangeTracker

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.item.FixedItemInv

FixedItemInv.CopyingFixedItemInv, FixedItemInv.ModifiableFixedItemInv

Nested classes/interfaces inherited from interface alexiil.mc.lib.attributes.item.LimitedFixedItemInv

LimitedFixedItemInv.ItemSlotLimitRule

Field Summary

Fields

Modifier and Type	Field	Description
protected ItemFilter[]	extractionFilters
protected ItemFilter[]	insertionFilters
protected byte[]	maxInsertionAmounts
protected byte[]	minimumAmounts

Fields inherited from class alexiil.mc.lib.attributes.item.impl.DelegatingFixedItemInv

delegate

Constructor Summary

Constructors

Constructor	Description
SimpleLimitedFixedItemInv(FixedItemInv delegate)

Method Summary

Modifier and Type	Method	Description
protected void	assertMutable()
LimitedFixedItemInv	copy()	Creates a copy of this LimitedFixedItemInv (with the same backing inventory and the same rules).
static SimpleLimitedFixedItemInv	createLimited(FixedItemInv inv)
net.minecraft.item.ItemStack	extractStack(int slot, ItemFilter filter, net.minecraft.item.ItemStack mergeWith, int maxCount, Simulation simulation)	Attempts to extract part of the stack that is held in the given slot.
ItemFilter	getFilterForSlot(int slot)	Exposes FixedItemInvView.isItemValidForSlot(int, ItemStack) as a (potentially) readable filter.
int	getMaxAmount(int slot, net.minecraft.item.ItemStack stack)
LimitedFixedItemInv.ItemSlotLimitRule	getRule(int slot)
LimitedFixedItemInv.ItemSlotLimitRule	getSubRule(int from, int to)
net.minecraft.item.ItemStack	insertStack(int slot, net.minecraft.item.ItemStack stack, Simulation simulation)	Attempts to insert the given stack into the given slot, returning the excess.
boolean	isItemValidForSlot(int slot, net.minecraft.item.ItemStack stack)	Checks to see if the given stack would be valid for this slot, ignoring the current contents.
SimpleLimitedFixedItemInv	markFinal()	Marks this object as final, and disallows any further changes to this.
boolean	setInvStack(int slot, net.minecraft.item.ItemStack to, Simulation simulation)	Sets the stack in the given slot to the given stack.

Methods inherited from class alexiil.mc.lib.attributes.item.impl.DelegatingFixedItemInv

addListener, createDelegate, getChangeValue, getInvStack, getSlotCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface alexiil.mc.lib.attributes.item.AbstractItemInvView

addListener, getChangeValue

Methods inherited from interface alexiil.mc.lib.attributes.item.FixedItemInv

createLimitedFixedInv, forceSetInvStack, getExtractable, getGroupedInv, getInsertable, getInvStack, getMappedInv, getSlot, getSubInv, getTransferable, modifySlot, slotIterable

Methods inherited from interface alexiil.mc.lib.attributes.item.FixedItemInvView

convertTo, getFixedView, getSlotCount, offerSelfAsAttribute, stackIterable

Methods inherited from interface alexiil.mc.lib.attributes.item.LimitedFixedItemInv

asUnmodifiable, getAllRule, reset

Field Details

insertionFilters

protected final ItemFilter[] insertionFilters

extractionFilters

protected final ItemFilter[] extractionFilters

maxInsertionAmounts

protected final byte[] maxInsertionAmounts

minimumAmounts

protected final byte[] minimumAmounts

Constructor Details

SimpleLimitedFixedItemInv

public SimpleLimitedFixedItemInv(FixedItemInv delegate)

Method Details

createLimited

public static SimpleLimitedFixedItemInv createLimited(FixedItemInv inv)

markFinal

public SimpleLimitedFixedItemInv markFinal()

Description copied from interface: LimitedFixedItemInv

Marks this object as final, and disallows any further changes to this. If this is called then LimitedFixedItemInv.asUnmodifiable() will return this object.

Specified by:

markFinal in interface LimitedFixedItemInv

Returns:

this.

assertMutable

protected void assertMutable()

copy

public LimitedFixedItemInv copy()

Description copied from interface: LimitedFixedItemInv

Creates a copy of this LimitedFixedItemInv (with the same backing inventory and the same rules). If this has been marked as final (LimitedFixedItemInv.markFinal()) then the copy will be marked as final as well..

Specified by:

copy in interface LimitedFixedItemInv

isItemValidForSlot

public boolean isItemValidForSlot(int slot,
 net.minecraft.item.ItemStack stack)

Description copied from interface: FixedItemInv

Checks to see if the given stack would be valid for this slot, ignoring the current contents. Note that this method should adhere to the requirements of ItemFilter.matches(ItemStack), so this must not care about the ItemStack.getCount(). Passing empty stacks will generally not return useful results.

Note that just because an ItemStack passes this validity test, and is stackable with the current stack, does not mean that you can insert the stack into this inventory..

Specified by:

isItemValidForSlot in interface FixedItemInv

Specified by:

isItemValidForSlot in interface FixedItemInvView

Overrides:

isItemValidForSlot in class DelegatingFixedItemInv

Parameters:

slot - The slot index. Must be a value between 0 (inclusive) and FixedItemInvView.getSlotCount() (exclusive) to be valid. (Like in arrays, lists, etc).

stack - The ItemStack to check. It's undefined what is returned if an empty stack is passed in, but it is not generally expected to be useful.

getFilterForSlot

public ItemFilter getFilterForSlot(int slot)

Description copied from interface: FixedItemInvView

Exposes FixedItemInvView.isItemValidForSlot(int, ItemStack) as a (potentially) readable filter.

Specified by:

getFilterForSlot in interface FixedItemInvView

Overrides:

getFilterForSlot in class DelegatingFixedItemInv

Parameters:

slot - The slot index. Must be a value between 0 (inclusive) and FixedItemInvView.getSlotCount() (exclusive) to be valid. (Like in arrays, lists, etc).

Returns:

An ItemFilter for what may be present in this slot. If this slot is filtered by an ItemFilter internally then it is highly recommended that this be overridden to return that filter rather than the default opaque wrapper around FixedItemInvView.isItemValidForSlot(int, ItemStack).

setInvStack

public boolean setInvStack(int slot,
 net.minecraft.item.ItemStack to,
 Simulation simulation)

Description copied from interface: FixedItemInv

Sets the stack in the given slot to the given stack.

Specified by:

setInvStack in interface FixedItemInv

Overrides:

setInvStack in class DelegatingFixedItemInv

to - The new ItemStack. It is not defined if you are allowed to modify this or not.

Returns:

True if the modification was allowed, false otherwise. (For example if the given stack doesn't pass the FixedItemInvView.isItemValidForSlot(int, ItemStack) test).

insertStack

public net.minecraft.item.ItemStack insertStack(int slot,
 net.minecraft.item.ItemStack stack,
 Simulation simulation)

Description copied from interface: FixedItemInv

Attempts to insert the given stack into the given slot, returning the excess.

(This is a slot-based version of ItemInsertable.attemptInsertion(ItemStack, Simulation) - if you want to use any of the other slot specific methods then it's recommended you get an ItemInsertable from FixedItemInv.getSlot(int)).

Specified by:

insertStack in interface FixedItemInv

Overrides:

insertStack in class DelegatingFixedItemInv

Parameters:

slot - The slot index. Must be a value between 0 (inclusive) and FixedItemInvView.getSlotCount() (exclusive) to be valid. (Like in arrays, lists, etc).

stack - The incoming stack. Must not be modified by this call.

simulation - If Simulation.SIMULATE then this shouldn't modify anything.

Returns:

the excess ItemStack that wasn't accepted. This will be independent of this insertable, however it might be the given stack instead of a completely new object.

extractStack

public net.minecraft.item.ItemStack extractStack(int slot,
 @Nullable
 ItemFilter filter,
 net.minecraft.item.ItemStack mergeWith,
 int maxCount,
 Simulation simulation)

Description copied from interface: FixedItemInv

Attempts to extract part of the stack that is held in the given slot.

This is a slot based version of ItemExtractable, however it includes a number of additional arguments. If you want to use any of the simpler methods than it's recommenced that you get an ItemExtractable from FixedItemInv.getSlot(int).

Specified by:

extractStack in interface FixedItemInv

Overrides:

extractStack in class DelegatingFixedItemInv

Parameters:

slot - The slot index. Must be a value between 0 (inclusive) and FixedItemInvView.getSlotCount() (exclusive) to be valid. (Like in arrays, lists, etc).

filter - If non-null then this will be checked against the stored stack to see if anything can be extracted.

mergeWith - If non-empty then this will be merged with the extracted stack, and as such they should be equal.

maxCount - The maximum number of items to extract. Note that if the "mergeWith" argument is non-empty then the actual limit should be the minimum of ItemStack.getMaxCount() and the given maxCount.

simulation - If Simulation.SIMULATE then this shouldn't modify anything.

Returns:

mergeWith (if non-empty) or the extracted stack if mergeWith is empty.

getMaxAmount

public int getMaxAmount(int slot,
 net.minecraft.item.ItemStack stack)

Specified by:

getMaxAmount in interface FixedItemInvView

Overrides:

getMaxAmount in class DelegatingFixedItemInv

Parameters:

slot - The slot index. Must be a value between 0 (inclusive) and FixedItemInvView.getSlotCount() (exclusive) to be valid. (Like in arrays, lists, etc).

stack - The stack to check for. May be an empty stack to get the maximum amount that this can hold of any stack.

Returns:

The maximum amount that the given slot can hold of the given stack. This method will ignore the current stack in FixedItemInvView.getInvStack(int). The default implementation just delegates to ItemStack.getMaxCount(). Note that any setters that this object implements (like FixedItemInv.setInvStack(int, ItemStack, Simulation) should reject stacks that are greater than this value. (and callers should only call this if they need to check the amounts separately. Note that it is meaningless to return values greater than the maximum amount an item can be stacked to here, and callers are free to throw an exception if this is violated. (Basically huge single-slot inventories shouldn't implement this interface).

getRule

public LimitedFixedItemInv.ItemSlotLimitRule getRule(int slot)

Specified by:

getRule in interface LimitedFixedItemInv

Returns:

A rule for the single slot.

getSubRule

public LimitedFixedItemInv.ItemSlotLimitRule getSubRule(int from,
 int to)

Specified by:

getSubRule in interface LimitedFixedItemInv

Parameters:

from - The first slot (inclusive)

to - The last slot (exclusive).

Returns:

A rule that applies to every slot between from and to.