org.spongepowered.api.block.tileentity

Interface TileEntityArchetype

All Superinterfaces:

Archetype<BlockSnapshot,TileEntity>, CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, PropertyHolder, ValueContainer<DataHolder>

public interface TileEntityArchetype
extends Archetype<BlockSnapshot,TileEntity>

Represents the data of a TileEntity which does not exist in the world and may be used to create new TileEntitys with the same data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TileEntityArchetype.Builder A builder for TileEntityArchetypes.

Method Summary

Modifier and Type	Method and Description
static TileEntityArchetype.Builder	builder() Creates a TileEntityArchetype.Builder to get TileEntityArchetypes.
TileEntityArchetype	copy() Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.
BlockState	getState() Gets the block state for this archetype.
DataContainer	getTileData() Gets the raw TileEntity data that would be applied to the generated tile entity.
TileEntityType	getTileEntityType() Gets the TileEntityType for this archetype.
void	setRawData(DataView container) Sets the raw data for the desired TileEntity.

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

apply, toSnapshot

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

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

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

Method Detail

builder

static TileEntityArchetype.Builder builder()

Creates a TileEntityArchetype.Builder to get TileEntityArchetypes.

Returns:

The new builder

getState

BlockState getState()

Gets the block state for this archetype. Note that this state is unchangeable, as much as getTileEntityType() is. The underlying data is mutable, but all the data is heavily tied to the tile entity type.

Returns:

The block state

getTileEntityType

TileEntityType getTileEntityType()

Gets the TileEntityType for this archetype.

Returns:

The tile entity type

getTileData

DataContainer getTileData()

Gets the raw TileEntity data that would be applied to the generated tile entity. Note that this is a copied container.

Returns:

The copied container of the tile entity

setRawData

void setRawData(DataView container)
         throws InvalidDataException

Sets the raw data for the desired TileEntity. Note that position values are not used as those are dependent on usage.

Specified by:

setRawData in interface DataHolder

Parameters:

container - A container containing all raw data to set on this data holder

Throws:

InvalidDataException - If the data is not valid for the archetyped tile entity

copy

TileEntityArchetype copy()

Description copied from interface: ValueContainer

Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.

Specified by:

copy in interface ValueContainer<DataHolder>

Returns:

The new copy