CarrierBlockEntity (SpongeAPI 8.2.0 API)

All Superinterfaces:

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

All Known Subinterfaces:

Barrel, BlastFurnace, BrewingStand, Campfire, Chest, Dispenser, Dropper, Furnace, FurnaceBlockEntity, Hopper, NameableCarrierBlockEntity, ShulkerBox, Smoker, TrappedChest
```
public interface CarrierBlockEntity
extends BlockEntity, BlockCarrier
```
Represents a BlockEntity that is a carrier of BlockEntityInventory.
Additional information regarding the CarrierBlockEntity is dependent on the BlockEntity itself.

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`BlockEntityInventory<CarrierBlockEntity>`	`inventory()`	Returns the inventory that this Carrier is holding.
`default java.util.Optional<Value.Mutable<java.lang.String>>`	`lockToken()`	`Keys.LOCK_TOKEN`

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.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.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
  - inventory
```
BlockEntityInventory<CarrierBlockEntity> inventory()
```
    Description copied from interface: Carrier
    
    Returns the inventory that this Carrier is holding.
    
    Specified by:
    
    inventory in interface Carrier
    
    Returns:
    
    The inventory this Carrier is holding
  - lockToken
```
default java.util.Optional<Value.Mutable<java.lang.String>> lockToken()
```
    Keys.LOCK_TOKEN
    The absence of the value signifies this BlockEntity has no lock.
    
    Returns:
    
    The lock token used for opening this BlockEntity.