org.spongepowered.api.block.tileentity

Interface TileEntity

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, Locatable, PropertyHolder, ValueContainer<DataHolder>

All Known Subinterfaces:

Banner, Beacon, Bed, BrewingStand, Chest, CommandBlock, Comparator, DaylightDetector, Dispenser, Dropper, EnchantmentTable, EnderChest, EndGateway, EndPortal, FlowerPot, Furnace, Hopper, Jukebox, MobSpawner, Note, Piston, ShulkerBox, Sign, Skull, Structure, TileEntityCarrier

public interface TileEntity
extends DataHolder, Locatable

Represents an abstract Tile Entity. It is a functional block that is continuously updated while residing in a world. It can perform specific functions based on the data that it contains.

A TileEntity is contained within a Location and will continue to exists so long as the Location is of the correct block type.

Since a TileEntity is performing various actions, all methods that are purely functional methods reside in the TileEntity, whereas customizable data associated with a TileEntity is represented by DataManipulator.

Method Summary

Modifier and Type	Method and Description
TileEntityArchetype	createArchetype() Creates a new TileEntityArchetype for use with Schematics and placing the archetype in multiple locations.
BlockState	getBlock() Gets the BlockState that this TileEntity represents.
LocatableBlock	getLocatableBlock() Creates a LocatableBlock for this TileEntity.
TileEntityType	getType() Gets the type of TileEntity this is.
boolean	isValid() Checks for whether the tile entity is currently valid or not.
void	setValid(boolean valid) Changes the validation of this tile entity.

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

setRawData, validateRawData

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

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

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

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

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

getLocation, getWorld

Method Detail

isValid

boolean isValid()

Checks for whether the tile entity is currently valid or not.

Use this method to check if processing should be run on this TileEntity. If it is valid, then processing can be run on it. If not, then processing should wait until it becomes valid or is destroyed.

Returns:

True if the tile entity is valid, false if not

setValid

void setValid(boolean valid)

Changes the validation of this tile entity.

If the tile entity is invalid, no processing will be done on this TileEntity until it either becomes valid or is reset on the next tick.

If the tile entity is valid, then processing can continue and this TileEntity will not be reset on the next tick.

Parameters:

valid - True if the tile entity should be validated, or false if it should be invalidated

getType

TileEntityType getType()

Gets the type of TileEntity this is.

Returns:

The type of tile entity

getBlock

BlockState getBlock()

Gets the BlockState that this TileEntity represents.

Returns:

The blockstate

createArchetype

TileEntityArchetype createArchetype()

Creates a new TileEntityArchetype for use with Schematics and placing the archetype in multiple locations.

Returns:

The created archetype for re-creating this tile entity

getLocatableBlock

LocatableBlock getLocatableBlock()

Creates a LocatableBlock for this TileEntity. Can be used as a simpler method of making them. Since this does not persist the data of this TileEntity, it should not be used in place of a BlockSnapshot where data is being safely cloned.

Returns:

The created locatable block, not as a block snapshot