org.spongepowered.api.entity

Interface EntityArchetype

All Superinterfaces:

Archetype<EntitySnapshot,Entity>, CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataHolder, DataSerializable, PropertyHolder, ValueContainer<DataHolder>

public interface EntityArchetype
extends Archetype<EntitySnapshot,Entity>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EntityArchetype.Builder A builder for EntityArchetypes.

Method Summary

Modifier and Type	Method and Description
static EntityArchetype.Builder	builder() Creates a EntityArchetype.Builder to get EntityArchetypes.
EntityArchetype	copy() Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.
DataContainer	getEntityData() Gets the raw Entity data that would be applied to the generated entity.
EntityType	getType() Gets the EntityType of the entity contained in this archetype.
static EntityArchetype	of(EntityType type) Creates a new EntityArchetype with the specified EntityType.
void	setRawData(DataView container) Attempts to set all data of this DataHolder according to the DataContainer's held information.

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

apply, toSnapshot

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

validateRawData

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.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

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

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

Method Detail

builder

static EntityArchetype.Builder builder()

Creates a EntityArchetype.Builder to get EntityArchetypes.

Returns:

The new builder

of

static EntityArchetype of(EntityType type)

Creates a new EntityArchetype with the specified EntityType.

Parameters:

type - Type of the entity

Returns:

An archetype of the given entity type

getType

EntityType getType()

Gets the EntityType of the entity contained in this archetype.

Returns:

The entity type

getEntityData

DataContainer getEntityData()

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

Note: While normally, an archetype does not contain position information, it is possible that Queries.POSITION are included as required by Schematics.

Returns:

The copied container of the entity

setRawData

void setRawData(DataView container)
         throws InvalidDataException

Description copied from interface: DataHolder

Attempts to set all data of this DataHolder according to the DataContainer's held information. Using this to modify known DataManipulator is unsupported and if the data is invalid, an InvalidDataException is thrown.

This setter is used to provide setting custom data that is not represented by the Data API, including forge mods and other unknown data. Attempts at validating known DataManipulators contained in the data container are made with the assumption that all necessary data exists.

Specified by:

setRawData in interface DataHolder

Parameters:

container - A container containing all raw data to set on this data holder

Throws:

InvalidDataException - If the container is missing or has invalid data that this holder will refuse

copy

EntityArchetype copy()

Description copied from interface: ValueContainer

Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.

Specified by:

copy in interface ValueContainer<DataHolder>

Returns:

The new copy