org.spongepowered.api.block

Interface BlockSnapshot

All Superinterfaces:

DataSerializable, ImmutableDataHolder<BlockSnapshot>, ImmutableValueStore<BlockSnapshot,ImmutableDataManipulator<?,?>>, LocatableSnapshot<BlockSnapshot>, PropertyHolder, ValueContainer<BlockSnapshot>

public interface BlockSnapshot
extends LocatableSnapshot<BlockSnapshot>

An immutable representation of a BlockState and any extra data that may be associated with it, including TileEntity related data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BlockSnapshot.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static BlockSnapshot	NONE Represents a BlockSnapshot with the default state of BlockTypes.AIR and a Location that cannot be determined.

Method Summary

Modifier and Type	Method and Description
static BlockSnapshot.Builder	builder() Creates a BlockSnapshot.Builder to get BlockSnapshots.
Optional<TileEntityArchetype>	createArchetype() Creates a new TileEntityArchetype for use with Schematics and placing the archetype in multiple locations.
Optional<UUID>	getCreator() Gets the UUID, if available, of the user who created this BlockSnapshot.
BlockState	getExtendedState() Gets the extended BlockState.
Optional<UUID>	getNotifier() Gets the UUID, if available, of the user who last notified this BlockSnapshot.
BlockState	getState() Gets the BlockState.
boolean	restore(boolean force, BlockChangeFlag flag) Restores the BlockSnapshot to the Location stored within the snapshot.
BlockSnapshot	withContainer(DataContainer container) Creates a copy of the BlockSnapshot with the provided DataContainer.
BlockSnapshot	withState(BlockState blockState) Creates a copy of the BlockSnapshot with the provided BlockState.

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

getLocation, getPosition, getWorldUniqueId, withLocation

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

getManipulators

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.immutable.ImmutableValueStore

get, getContainers, getOrCreate, merge, merge, supports, transform, with, with, with, with, without

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

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

Field Detail

NONE

static final BlockSnapshot NONE

Represents a BlockSnapshot with the default state of BlockTypes.AIR and a Location that cannot be determined.

Method Detail

builder

static BlockSnapshot.Builder builder()

Creates a BlockSnapshot.Builder to get BlockSnapshots.

Returns:

The new builder

getState

BlockState getState()

Gets the BlockState.

Returns:

The BlockState

getExtendedState

BlockState getExtendedState()

Gets the extended BlockState. This applies extended properties that are usually located around the associated BlockType. Check BlockState.withExtendedProperties(Location) for more info.

Returns:

The extended BlockState

withState

BlockSnapshot withState(BlockState blockState)

Creates a copy of the BlockSnapshot with the provided BlockState. Any additional data associated with a TileEntity or custom data may be lost.

Note: all custom data, including implementation detailed data relating to any and all TileEntity instances that was included in this snapshot will NOT copy over to the new snapshot.

Parameters:

blockState - The block state

Returns:

The new snapshot

withContainer

BlockSnapshot withContainer(DataContainer container)

Creates a copy of the BlockSnapshot with the provided DataContainer. Note that this is equal to calling DataBuilder.build(DataView). All data is validated and

Parameters:

container - The data container

Returns:

The new snapshot

restore

boolean restore(boolean force,
                BlockChangeFlag flag)

Restores the BlockSnapshot to the Location stored within the snapshot. If the Location is not available, the snapshot will not be restored.

If forced, the state of the block will change its BlockType to match that of the snapshot then set the state. However, if force is set to false and the BlockTypes does not match, false will be returned. If notifyNeighbors is true, neighboring blocks will be notified of changes at the restored block location triggering physic updates.

Parameters:

force - If true, forces block state to be set even if the BlockType does not match the snapshot one.

flag - The block change flags to determine whether neighbors are notified, block physics performed, etc.

Returns:

True if the restore was successful, false otherwise

getCreator

Optional<UUID> getCreator()

Gets the UUID, if available, of the user who created this BlockSnapshot.

Returns:

The UUID if available

getNotifier

Optional<UUID> getNotifier()

Gets the UUID, if available, of the user who last notified this BlockSnapshot.

Returns:

The UUID if available

createArchetype

Optional<TileEntityArchetype> createArchetype()

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

If this blocksnapshot does not contain a tile entity then this will return Optional.empty().

Returns:

The created archetype for re-creating this tile entity