org.spongepowered.api.entity

Interface EntitySnapshot

All Superinterfaces:

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

public interface EntitySnapshot
extends LocatableSnapshot<EntitySnapshot>

Represents a snapshot of an Entity and all of it's related data in the form of ImmutableDataManipulators and ImmutableValues. While an Entity is a live instance and therefor residing 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 and Description
static interface	EntitySnapshot.Builder An ImmutableDataBuilder for building EntitySnapshots.

Method Summary

Modifier and Type	Method and 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<Transform<World>>	getTransform() Gets the Transform as an Optional as the Location may be undefined if this EntitySnapshot was built without a location.
EntityType	getType() Gets the EntityType.
Optional<UUID>	getUniqueId() Gets an Optional containing the UUID of the Entity that this EntitySnapshot is representing.
Optional<Entity>	restore() Restores the EntitySnapshot to the Location stored within the snapshot.

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

Method Detail

builder

static EntitySnapshot.Builder builder()

Creates a new EntitySnapshot.Builder to build an EntitySnapshot.

Returns:

The new builder

getUniqueId

Optional<UUID> getUniqueId()

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

getTransform

Optional<Transform<World>> getTransform()

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

Returns:

The transform, if available

getType

EntityType getType()

Gets the EntityType.

Returns:

The EntityType

restore

Optional<Entity> restore()

Restores the EntitySnapshot to the Location stored within the snapshot. If the Location 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