Package org.spongepowered.api.block.entity

Interface BlockEntityArchetype.Builder

All Superinterfaces:

AbstractBuilder<BlockEntityArchetype>, Builder<BlockEntityArchetype,BlockEntityArchetype.Builder>, CopyableBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>, DataBuilder<BlockEntityArchetype>, DataHolderBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>, DataHolderBuilder.Mutable<BlockEntityArchetype,BlockEntityArchetype.Builder>, ResettableBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>, SerializableDataHolderBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>, SerializableDataHolderBuilder.Mutable<BlockEntityArchetype,BlockEntityArchetype.Builder>

Enclosing interface:

BlockEntityArchetype

public static interface BlockEntityArchetype.Builder
extends SerializableDataHolderBuilder.Mutable<BlockEntityArchetype,BlockEntityArchetype.Builder>

A builder for BlockEntityArchetypes.

Nested Class Summary

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

DataHolderBuilder.Immutable<H extends DataHolder.Immutable<H>,B extends DataHolderBuilder.Immutable<H,B>>, DataHolderBuilder.Mutable<H extends DataHolder.Mutable,B extends DataHolderBuilder.Mutable<H,B>>

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

SerializableDataHolderBuilder.Immutable<H extends SerializableDataHolder.Immutable<H>,B extends SerializableDataHolderBuilder.Immutable<H,B>>, SerializableDataHolderBuilder.Mutable<H extends SerializableDataHolder.Mutable,B extends SerializableDataHolderBuilder.Mutable<H,B>>

Method Summary

Modifier and Type	Method	Description
default BlockEntityArchetype.Builder	blockEntity(Supplier<? extends BlockEntityType> type)
BlockEntityArchetype.Builder	blockEntity(BlockEntity blockEntity)	Copies the incoming BlockEntity for it's current state of information, such as BlockState, BlockEntityType, and all related contained data, except the position and potentially any Sponge-added tracking information, such as owner or notifier.
BlockEntityArchetype.Builder	blockEntity(BlockEntityType type)
BlockEntityArchetype.Builder	blockEntityData(DataView dataView)	Sets the DataView to be used to copy data onto the created BlockEntity when Archetype.apply(ServerLocation) is called.
BlockEntityArchetype	build()	Creates a new BlockEntityArchetype from this builder.
BlockEntityArchetype.Builder	from(BlockEntityArchetype value)	Copies all known DataManipulators from the given DataHolder of type DataHolderBuilder.
BlockEntityArchetype.Builder	from(ServerLocation location)
BlockEntityArchetype.Builder	reset()	Resets this builder to a "default" state such that there is no remaining data to set.
BlockEntityArchetype.Builder	state(BlockState state)	Sets the BlockState of the archetype.

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

build

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

add, add, add, add, add, addFrom

Method Details

reset

BlockEntityArchetype.Builder reset()

Description copied from interface: Builder

Resets this builder to a "default" state such that there is no remaining data to set. This is to be the presumed "default" state.

Specified by:

reset in interface Builder<BlockEntityArchetype,BlockEntityArchetype.Builder>

Specified by:

reset in interface DataHolderBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>

Specified by:

reset in interface ResettableBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>

Returns:

This builder, for chaining

from

BlockEntityArchetype.Builder from(BlockEntityArchetype value)

Description copied from interface: DataHolderBuilder

Copies all known DataManipulators from the given DataHolder of type DataHolderBuilder. This is a defensive copy as DataManipulator is mutable.

Specified by:

from in interface CopyableBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>

Specified by:

from in interface DataHolderBuilder<BlockEntityArchetype,BlockEntityArchetype.Builder>

Parameters:

value - The DataHolder to copy from

Returns:

This builder for chaining

from

BlockEntityArchetype.Builder from(ServerLocation location)

state

BlockEntityArchetype.Builder state(BlockState state)

Sets the BlockState of the archetype.

Parameters:

state - The new block state

Returns:

This builder, for chaining

blockEntity

default BlockEntityArchetype.Builder blockEntity(Supplier<? extends BlockEntityType> type)

blockEntity

BlockEntityArchetype.Builder blockEntity(BlockEntityType type)

blockEntity

BlockEntityArchetype.Builder blockEntity(BlockEntity blockEntity)

Copies the incoming BlockEntity for it's current state of information, such as BlockState, BlockEntityType, and all related contained data, except the position and potentially any Sponge-added tracking information, such as owner or notifier.

Note that this overwrites data set from the following methods:

• from(ServerLocation)
• state(BlockState)
• blockEntity(BlockEntityType)
• blockEntityData(DataView)
• DataHolderBuilder.add(Value)
• DataHolderBuilder.add(Key, Object)
• DataHolderBuilder.add(DataManipulator)

Parameters:

blockEntity - The block entity to absorb all data

Returns:

This builder, for chaining

blockEntityData

BlockEntityArchetype.Builder blockEntityData(DataView dataView)

Sets the DataView to be used to copy data onto the created BlockEntity when Archetype.apply(ServerLocation) is called.

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.

Parameters:

dataView - The data view containing data pertinent to the BlockEntity

Returns:

This builder, for chaining

build

BlockEntityArchetype build()

Creates a new BlockEntityArchetype from this builder.

Specified by:

build in interface AbstractBuilder<BlockEntityArchetype>

Returns:

The new instance