org.spongepowered.api.item.inventory.type

Interface OrderedInventory

All Superinterfaces:

Inventory, Iterable<Inventory>, Nameable

All Known Subinterfaces:

CraftingGridInventory, CraftingInventory, EquipmentInventory, GridInventory, Hotbar, Inventory2D, InventoryColumn, InventoryRow, MainPlayerInventory

public interface OrderedInventory
extends Inventory

An Ordered Inventory contains Slots in some pre-determined order with indices between 0 and 1-Inventory.capacity().

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.item.inventory.Inventory

Inventory.Builder

Method Summary

Modifier and Type	Method and Description
Optional<Slot>	getSlot(SlotIndex index) Gets the Slot at the specified position.
Optional<ItemStack>	peek(SlotIndex index) Gets without removing the stack at the supplied index in this Inventory.
Optional<ItemStack>	peek(SlotIndex index, int limit) Gets without removing the stack at the supplied index in this Inventory.
Optional<ItemStack>	poll(SlotIndex index) Gets and remove the stack at the supplied index in this Inventory.
Optional<ItemStack>	poll(SlotIndex index, int limit) Gets and remove the stack at the supplied index in this Inventory.
InventoryTransactionResult	set(SlotIndex index, ItemStack stack) Sets the item in the specified slot.

Methods inherited from interface org.spongepowered.api.item.inventory.Inventory

builder, canFit, capacity, clear, contains, contains, containsAny, containsInventory, first, getArchetype, getInventoryProperty, getInventoryProperty, getMaxStackSize, getPlugin, getProperties, getProperties, getProperty, getProperty, hasChildren, intersect, next, offer, parent, peek, peek, poll, poll, query, query, query, query, query, query, query, queryAny, root, set, setMaxStackSize, size, slots, totalItems, transform, union

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.spongepowered.api.Nameable

getName

Method Detail

poll

Optional<ItemStack> poll(SlotIndex index)

Gets and remove the stack at the supplied index in this Inventory.

Parameters:

index - slot index to query

Returns:

matching stacks, as per the semantics of Inventory.poll()

See Also:

Inventory.poll()

poll

Optional<ItemStack> poll(SlotIndex index,
                         int limit)

Gets and remove the stack at the supplied index in this Inventory.

Parameters:

index - slot index to query

limit - item limit

Returns:

matching stacks, as per the semantics of Inventory.poll()

See Also:

Inventory.poll()

peek

Optional<ItemStack> peek(SlotIndex index)

Gets without removing the stack at the supplied index in this Inventory.

Parameters:

index - slot index to query

Returns:

matching stacks, as per the semantics of Inventory.peek()

See Also:

Inventory.peek()

peek

Optional<ItemStack> peek(SlotIndex index,
                         int limit)

Gets without removing the stack at the supplied index in this Inventory.

Parameters:

index - slot index to query

limit - item limit

Returns:

matching stacks, as per the semantics of Inventory.peek()

See Also:

Inventory.peek()

set

InventoryTransactionResult set(SlotIndex index,
                               ItemStack stack)

Sets the item in the specified slot.

Parameters:

index - Slot index to set

stack - Stack to insert

Returns:

matching stacks, as per the semantics of Inventory.set(org.spongepowered.api.item.inventory.ItemStack)

See Also:

Inventory.set(ItemStack)

getSlot

Optional<Slot> getSlot(SlotIndex index)

Gets the Slot at the specified position.

Parameters:

index - Slot index to retrieve

Returns:

slot at the specified position, or Optional.empty() if no matching slot