org.spongepowered.api.item.inventory.type

Interface Inventory2D

All Superinterfaces:

Inventory, Iterable<Inventory>, Nameable, OrderedInventory

All Known Subinterfaces:

CraftingGridInventory, GridInventory, Hotbar, InventoryColumn, InventoryRow, MainPlayerInventory

public interface Inventory2D
extends OrderedInventory

Base interface for inventories with slots obtainable via SlotPos queries.

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(SlotPos pos) Gets the Slot at the specified position.
Optional<ItemStack>	peek(SlotPos pos) Gets without removing the stack at the supplied position in this Inventory.
Optional<ItemStack>	peek(SlotPos pos, int limit) Gets without removing the stack at the supplied position in this Inventory.
Optional<ItemStack>	poll(SlotPos pos) Gets and remove the stack at the supplied position in this Inventory.
Optional<ItemStack>	poll(SlotPos pos, int limit) Gets and remove the stack at the supplied position in this Inventory.
InventoryTransactionResult	set(SlotPos pos, ItemStack stack) Sets the item in the specified slot.

Methods inherited from interface org.spongepowered.api.item.inventory.type.OrderedInventory

getSlot, peek, peek, poll, poll, set

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(SlotPos pos)

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

Parameters:

pos - Slot position to query

Returns:

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

See Also:

Inventory.poll()

poll

Optional<ItemStack> poll(SlotPos pos,
                         int limit)

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

Parameters:

pos - Slot position to query

limit - item limit

Returns:

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

See Also:

Inventory.poll()

peek

Optional<ItemStack> peek(SlotPos pos)

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

Parameters:

pos - Slot position to query

Returns:

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

See Also:

Inventory.peek()

peek

Optional<ItemStack> peek(SlotPos pos,
                         int limit)

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

Parameters:

pos - Slot position to query

limit - item limit

Returns:

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

See Also:

Inventory.peek()

set

InventoryTransactionResult set(SlotPos pos,
                               ItemStack stack)

Sets the item in the specified slot.

Parameters:

pos - Slot position 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(SlotPos pos)

Gets the Slot at the specified position.

Parameters:

pos - Slot position to retrieve

Returns:

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