Package org.spongepowered.api.block.entity

Interface BlockEntityArchetype

All Superinterfaces:

Archetype<BlockSnapshot,BlockEntity>, CopyableDataHolder, DataHolder, DataHolder.Mutable, DataSerializable, SerializableDataHolder, SerializableDataHolder.Mutable, ValueContainer

public interface BlockEntityArchetype
extends Archetype<BlockSnapshot,BlockEntity>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BlockEntityArchetype.Builder	A builder for BlockEntityArchetypes.

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
DataContainer	blockEntityData()	Gets the raw BlockEntity data that would be applied to the generated block entity.
BlockEntityType	blockEntityType()	Gets the BlockEntityType for this archetype.
static BlockEntityArchetype.Builder	builder()	Creates a BlockEntityArchetype.Builder to get BlockEntityArchetypes.
BlockEntityArchetype	copy()	Creates a clone copy of this CopyableDataHolder as a new CopyableDataHolder such that all the Values are safely duplicated to the new instance.
void	setRawData(DataView container)	Sets the raw data for the desired BlockEntity.
BlockState	state()	Gets the block state for this archetype.

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

apply, toSnapshot

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.data.SerializableDataHolder

validateRawData

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

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

Method Details

builder

static BlockEntityArchetype.Builder builder()

Creates a BlockEntityArchetype.Builder to get BlockEntityArchetypes.

Returns:

The new builder

state

BlockState state()

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

Returns:

The block state

blockEntityType

BlockEntityType blockEntityType()

Gets the BlockEntityType for this archetype.

Returns:

The block entity type

blockEntityData

DataContainer blockEntityData()

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

The format used for this container follows the Mojang ChunkFormat for BlockEntities., and can be customized based on the origination of the BlockEntity. If the block entity originates from a content-adding mod, the format could vary based on it's implementation and may change at any time.

Returns:

The copied container of the block entity

setRawData

void setRawData(DataView container)
         throws InvalidDataException

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

The format used for this container follows the Mojang ChunkFormat for BlockEntities., and can be customized based on the origination of the BlockEntity. If the block entity originates from a content-adding mod, the format could vary based on it's implementation and may change at any time.

Specified by:

setRawData in interface SerializableDataHolder.Mutable

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 block entity

copy

BlockEntityArchetype copy()

Description copied from interface: CopyableDataHolder

Creates a clone copy of this CopyableDataHolder as a new CopyableDataHolder such that all the Values are safely duplicated to the new instance. It is not guaranteed that the returning container is of the same type as this container.

Specified by:

copy in interface Archetype<BlockSnapshot,BlockEntity>

Specified by:

copy in interface CopyableDataHolder

Specified by:

copy in interface SerializableDataHolder

Specified by:

copy in interface SerializableDataHolder.Mutable

Returns:

The new copy