Package org.spongepowered.api.item.inventory.type

Interface ViewableInventory

All Superinterfaces:

Inventory, ValueContainer

All Known Subinterfaces:

BlockEntityInventory<T>, ViewableInventory.Custom

public interface ViewableInventory
extends Inventory

Interface for inventories which may be interacted with by Players.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ViewableInventory.Builder	A builder for inventories conforming to a ContainerType
static interface	ViewableInventory.Custom	A custom ViewableInventory created using the builder()

Method Summary

Modifier and Type	Method	Description
InventoryMenu	asMenu()	Create a new InventoryMenu based on this ViewableInventory which allows for lightweight callbacks on inventory clicks and changes.
static ViewableInventory.Builder	builder()	Creates a new ViewableInventory.Builder to build an ViewableInventory.
boolean	canInteractWith(ServerPlayer player)	Gets whether the specified player can interact with this object.
boolean	hasViewers()	Checks for whether this Inventory currently has viewers.
Set<ServerPlayer>	viewers()	Gets the current viewers looking at this Inventory.

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

asViewable, canFit, capacity, children, clear, contains, contains, containsAny, containsChild, containsInventory, freeCapacity, get, get, hasChildren, intersect, offer, offer, parent, peek, peekAt, poll, poll, pollFrom, pollFrom, query, query, query, query, query, query, root, set, slot, slots, totalQuantity, union

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Details

viewers

Set<ServerPlayer> viewers()

Gets the current viewers looking at this Inventory.

Returns:

The current viewers of this inventory

hasViewers

boolean hasViewers()

Checks for whether this Inventory currently has viewers.

Returns:

True if viewers are currently looking at this inventory

canInteractWith

boolean canInteractWith(ServerPlayer player)

Gets whether the specified player can interact with this object.

Parameters:

player - the Player wishing to interact with this Inventory

Returns:

true if the Entity is able to interact with this Inventory

asMenu

InventoryMenu asMenu()

Create a new InventoryMenu based on this ViewableInventory which allows for lightweight callbacks on inventory clicks and changes. To receive callbacks the inventory must be opened from InventoryMenu.open(ServerPlayer)

Returns:

The new InventoryMenu

builder

static ViewableInventory.Builder builder()

Creates a new ViewableInventory.Builder to build an ViewableInventory.

Returns:

The builder