Package org.spongepowered.api.block.entity.carrier.chest

Interface Chest

All Superinterfaces:

BlockCarrier, BlockEntity, Carrier, CarrierBlockEntity, CopyableDataHolder, DataHolder, DataHolder.Mutable, DataSerializable, Locatable, NameableBlockEntity, NameableCarrierBlockEntity, SerializableDataHolder, SerializableDataHolder.Mutable, ValueContainer

All Known Subinterfaces:

TrappedChest

public interface Chest
extends NameableCarrierBlockEntity

Represents a Chest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Nested classes/interfaces inherited from interface org.spongepowered.api.data.SerializableDataHolder

SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>, SerializableDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
default Value.Mutable<ChestAttachmentType>	attachmentType()	Keys.CHEST_ATTACHMENT_TYPE
Optional<Chest>	connectedChest()	Returns the connected Chest, if available.
Optional<Inventory>	doubleChestInventory()	Returns the inventory representing the combination of this chest and its neighbor (which form a double chest), if available.

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

inventory

Methods inherited from interface org.spongepowered.api.block.entity.BlockEntity

block, copy, createArchetype, isValid, locatableBlock, mirror, mirror, rotate, rotate, setValid, type

Methods inherited from interface org.spongepowered.api.block.entity.carrier.CarrierBlockEntity

inventory, lockToken

Methods inherited from interface org.spongepowered.api.data.DataHolder.Mutable

copyFrom, copyFrom, offer, offer, offer, offer, offerAll, offerAll, offerAll, offerAll, offerAll, offerAll, offerSingle, offerSingle, offerSingle, offerSingle, remove, remove, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeKey, removeKey, removeSingle, removeSingle, transform, transform, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Methods inherited from interface org.spongepowered.api.world.Locatable

blockPosition, location, serverLocation, world

Methods inherited from interface org.spongepowered.api.block.entity.NameableBlockEntity

displayName

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder

validateRawData

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Mutable

setRawData

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

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

Method Detail

doubleChestInventory

Optional<Inventory> doubleChestInventory()

Returns the inventory representing the combination of this chest and its neighbor (which form a double chest), if available.

If this chest is not part of a double chest, then this method will return Optional.empty().

Returns:

The combined inventory, if available

connectedChest

Optional<Chest> connectedChest()

Returns the connected Chest, if available.

If this chest is not part of a double chest, then this method will return Optional.empty().

Returns:

The connected Chest, if available

attachmentType

default Value.Mutable<ChestAttachmentType> attachmentType()

Keys.CHEST_ATTACHMENT_TYPE

Returns:

The attachment type of this chest.