Package org.spongepowered.api.entity

Interface EntitySnapshot

All Superinterfaces:

CopyableDataHolder, DataHolder, DataHolder.Immutable<EntitySnapshot>, DataSerializable, LocatableSnapshot<EntitySnapshot>, SerializableDataHolder, SerializableDataHolder.Immutable<EntitySnapshot>, ValueContainer

public interface EntitySnapshot
extends LocatableSnapshot<EntitySnapshot>

Represents a snapshot of an Entity and all of it's related data in the form of DataManipulator.Immutables and Value.Immutables. While an Entity is a live instance and resides in a World, an EntitySnapshot may be snapshotted of a World that is not currently loaded, or may not exist any longer.

All data associated with the EntitySnapshot should be separated from the Game instance such that external processing, building, and manipulation can take place.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntitySnapshot.Builder	An DataHolderBuilder.Immutable for building EntitySnapshots.

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
static EntitySnapshot.Builder	builder()	Creates a new EntitySnapshot.Builder to build an EntitySnapshot.
EntityArchetype	createArchetype()	Creates a new EntityArchetype for use with Schematics and placing the archetype in multiple locations.
Optional<Entity>	restore()	Restores the EntitySnapshot to the ServerLocation stored within the snapshot.
Optional<Transform>	transform()	Gets the Transform as an Optional as the ServerLocation may be undefined if this EntitySnapshot was built without a location.
EntityType<?>	type()	Gets the EntityType.
Optional<UUID>	uniqueId()	Gets an Optional containing the UUID of the Entity that this EntitySnapshot is representing.

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

mergeWith, mergeWith, transform, transform, with, with, with, without, without, without

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

contentVersion, toContainer

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

location, position, withLocation, world

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

validateRawData

Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Immutable

copy, withRawData

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 EntitySnapshot.Builder builder()

Creates a new EntitySnapshot.Builder to build an EntitySnapshot.

Returns:

The new builder

uniqueId

Optional<UUID> uniqueId()

Gets an Optional containing the UUID of the Entity that this EntitySnapshot is representing. If the Optional is Optional.empty(), then this snapshot must have been created by an EntitySnapshot.Builder without an Entity as a source.

Returns:

The Optional where the UUID may be present

transform

Optional<Transform> transform()

Gets the Transform as an Optional as the ServerLocation may be undefined if this EntitySnapshot was built without a location. This method is linked to LocatableSnapshot.location() such that if there is a ServerLocation, there is usually a Transform.

Returns:

The transform, if available

type

EntityType<?> type()

Gets the EntityType.

Returns:

The EntityType

restore

Optional<Entity> restore()

Restores the EntitySnapshot to the ServerLocation stored within the snapshot. If the ServerLocation is not available, the snapshot will not be restored.

Returns:

the restored entity if successful

createArchetype

EntityArchetype createArchetype()

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

Returns:

The created archetype for re-creating this entity