org.spongepowered.api.item.inventory

Interface Container

All Superinterfaces:

Interactable, Inventory, Iterable<Inventory>, Nameable

public interface Container
extends Interactable

A Container is effectively a ViewModel for a particular set of Inventory objects used to allow players to interact with the Inventories, usually via a GUI (the View).

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
void	close(Player viewer) Stops showing this Inventory to the given viewer.
Set<Player>	getViewers() Gets the current viewers looking at this Inventory.
boolean	hasViewers() Checks for whether this Inventory currently has viewers.
boolean	isViewedSlot(Slot slot) Returns whether given slot is part of the viewed inventories but not part of the viewers own inventory.
void	open(Player viewer) Shows this Inventory to the given viewer.

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

canInteractWith

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

getViewers

Set<Player> getViewers()

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

open

void open(Player viewer)
   throws IllegalArgumentException

Shows this Inventory to the given viewer.

Parameters:

viewer - The viewer to show this inventory to

Throws:

IllegalArgumentException - if a PluginContainer is not the root of the cause

close

void close(Player viewer)
    throws IllegalArgumentException

Stops showing this Inventory to the given viewer.

Parameters:

viewer - The viewer to stop showing this inventory to

Throws:

IllegalArgumentException - if a PluginContainer is not the root of the cause

isViewedSlot

boolean isViewedSlot(Slot slot)

Returns whether given slot is part of the viewed inventories but not part of the viewers own inventory.

Examples for viewed inventory slots:

All the slots of the opened chest and not the player grid below.

The slots of the crafting grid in the opened player inventory.

Parameters:

slot - The slot to check.

Returns:

true when the slot is part of the viewed inventories.