org.spongepowered.api.world.schematic

Interface Schematic

All Superinterfaces:

ArchetypeVolume, BlockVolume, MutableBlockVolume

public interface Schematic
extends ArchetypeVolume

A special archetype volume designed to be persisted. Contains additional metadata to assist with this persistence.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Schematic.Builder A builder for Schematics.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_AUTHOR
static String	METADATA_DATE
static String	METADATA_NAME
static String	METADATA_REQUIRED_MODS

Method Summary

Modifier and Type	Method and Description
static Schematic.Builder	builder() Gets a new builder for schematics.
default Palette<BiomeType>	getBiomePalette() Gets the Palette used by this schematic for serialization.
default Optional<MutableBiomeVolume>	getBiomes() Gets the MutableBiomeVolume of this schematic.
default Palette<BlockState>	getBlockPalette() Gets the BlockPalette used by this schematic for serialization.
MutableBlockVolumeWorker<Schematic>	getBlockWorker() Gets a new block worker for this block volume.
default ListMultimap<com.flowpowered.math.vector.Vector3d,EntityArchetype>	getEntitiesByPosition()
default Collection<EntityArchetype>	getEntityArchetypes()
DataView	getMetadata() Gets any additional metadata attached to this schematic.
BlockPalette	getPalette() Deprecated.

Methods inherited from interface org.spongepowered.api.world.extent.ArchetypeVolume

apply, getEntityArchetype, getTileEntityArchetype, getTileEntityArchetype, getTileEntityArchetypes

Methods inherited from interface org.spongepowered.api.world.extent.MutableBlockVolume

getBlockView, getBlockView, getRelativeBlockView, setBlock, setBlock, setBlockType, setBlockType

Methods inherited from interface org.spongepowered.api.world.extent.BlockVolume

containsBlock, containsBlock, getBlock, getBlock, getBlockCopy, getBlockCopy, getBlockMax, getBlockMin, getBlockSize, getBlockType, getBlockType, getImmutableBlockCopy, getUnmodifiableBlockView

Field Detail

METADATA_NAME

static final String METADATA_NAME

See Also:

Constant Field Values

METADATA_AUTHOR

static final String METADATA_AUTHOR

See Also:

Constant Field Values

METADATA_DATE

static final String METADATA_DATE

See Also:

Constant Field Values

METADATA_REQUIRED_MODS

static final String METADATA_REQUIRED_MODS

See Also:

Constant Field Values

Method Detail

builder

static Schematic.Builder builder()

Gets a new builder for schematics.

Returns:

The new builder

getPalette

@Deprecated
BlockPalette getPalette()

Deprecated.

Gets the BlockPalette used by this schematic for serialization.

Returns:

The palette

getBlockPalette

default Palette<BlockState> getBlockPalette()

Gets the BlockPalette used by this schematic for serialization.

Returns:

The block palette

getBiomePalette

default Palette<BiomeType> getBiomePalette()

Gets the Palette used by this schematic for serialization.

Returns:

The biome palette used for this schematic

getMetadata

DataView getMetadata()

Gets any additional metadata attached to this schematic.

Returns:

The additional metadata

getBlockWorker

MutableBlockVolumeWorker<Schematic> getBlockWorker()

Description copied from interface: BlockVolume

Gets a new block worker for this block volume.

Specified by:

getBlockWorker in interface ArchetypeVolume

Specified by:

getBlockWorker in interface BlockVolume

Specified by:

getBlockWorker in interface MutableBlockVolume

Returns:

The block worker

getBiomes

default Optional<MutableBiomeVolume> getBiomes()

Gets the MutableBiomeVolume of this schematic. As biomes are optionally included and not required, they may be optionally excluded. If the schematic would contain them, they will be present during deserialization via DataTranslator.

Returns:

The biomes volume, if they're included

getEntitiesByPosition

default ListMultimap<com.flowpowered.math.vector.Vector3d,EntityArchetype> getEntitiesByPosition()

Specified by:

getEntitiesByPosition in interface ArchetypeVolume

getEntityArchetypes

default Collection<EntityArchetype> getEntityArchetypes()

Specified by:

getEntityArchetypes in interface ArchetypeVolume