org.spongepowered.api.item.inventory.type

Interface GridInventory

All Superinterfaces:

Inventory, Inventory2D, Iterable<Inventory>, Nameable, OrderedInventory

All Known Subinterfaces:

CraftingGridInventory, MainPlayerInventory

public interface GridInventory
extends Inventory2D

An GridInventory is an Inventory which is ordered into a coherent grid format, meaning that its slots can be referred to by X-Y coordinates as well as single indices.

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<InventoryColumn>	getColumn(int x) Gets the column at the specified index.
int	getColumns() Gets the number of columns in the inventory.
com.flowpowered.math.vector.Vector2i	getDimensions() Returns the dimensions of this GridInventory as a Vector2i.
Optional<InventoryRow>	getRow(int y) Gets the row at the specified index.
int	getRows() Gets the number of rows in the inventory.
Optional<Slot>	getSlot(int x, int y) Gets the Slot at the specified position.
Optional<ItemStack>	peek(int x, int y) Gets without removing the stack at the supplied position in this Inventory.
Optional<ItemStack>	peek(int x, int y, int limit) Gets without removing the stack at the supplied position in this Inventory.
Optional<ItemStack>	poll(int x, int y) Gets and remove the stack at the supplied position in this Inventory.
Optional<ItemStack>	poll(int x, int y, int limit) Gets and remove the stack at the supplied position in this Inventory.
InventoryTransactionResult	set(int x, int y, ItemStack stack) Sets the item in the specified slot.

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

getSlot, peek, peek, poll, poll, set

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

getColumns

int getColumns()

Gets the number of columns in the inventory.

Returns:

The width of this ItemGrid.

getRows

int getRows()

Gets the number of rows in the inventory.

Returns:

The height of this ItemGrid.

getDimensions

com.flowpowered.math.vector.Vector2i getDimensions()

Returns the dimensions of this GridInventory as a Vector2i.

Returns:

The dimensions of this GridInventory.

poll

Optional<ItemStack> poll(int x,
                         int y)

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

Parameters:

x - x coordinate

y - y coordinate

Returns:

ItemStack at the specified position or Optional.empty() if the slot is empty or out of bounds

See Also:

Inventory.poll()

poll

Optional<ItemStack> poll(int x,
                         int y,
                         int limit)

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

Parameters:

x - x coordinate

y - y coordinate

limit - item limit

Returns:

ItemStack at the specified position or Optional.empty() if the slot is empty or out of bounds

See Also:

Inventory.poll()

peek

Optional<ItemStack> peek(int x,
                         int y)

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

Parameters:

x - x coordinate

y - y coordinate

Returns:

ItemStack at the specified position or Optional.empty() if the slot is empty or out of bounds

See Also:

Inventory.peek()

peek

Optional<ItemStack> peek(int x,
                         int y,
                         int limit)

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

Parameters:

x - x coordinate

y - y coordinate

limit - item limit

Returns:

ItemStack at the specified position or Optional.empty() if the slot is empty or out of bounds

See Also:

Inventory.peek()

set

InventoryTransactionResult set(int x,
                               int y,
                               ItemStack stack)

Sets the item in the specified slot.

Parameters:

x - x coordinate

y - y coordinate

stack - Item stack to insert

Returns:

operation result

See Also:

Inventory.set(ItemStack)

getSlot

Optional<Slot> getSlot(int x,
                       int y)

Gets the Slot at the specified position.

Parameters:

x - x coordinate

y - y coordinate

Returns:

Slot at the specified position or Optional.empty() if the coordinates are out of bounds

getRow

Optional<InventoryRow> getRow(int y)

Gets the row at the specified index.

Parameters:

y - y coordinate

Returns:

InventoryRow at the specified position or Optional.empty() if the specified row is out of bounds

getColumn

Optional<InventoryColumn> getColumn(int x)

Gets the column at the specified index.

Parameters:

x - x coordinate

Returns:

InventoryColumn at the specified position or Optional.empty() if the specified column is out of bounds