Package org.spongepowered.api.world.schematic

Interface Schematic

All Superinterfaces:

ArchetypeVolume, BiomeVolume, BiomeVolume.Modifiable<ArchetypeVolume>, BiomeVolume.Streamable<ArchetypeVolume>, BlockEntityArchetypeVolume, BlockEntityArchetypeVolume.Modifiable<ArchetypeVolume>, BlockEntityArchetypeVolume.Streamable<ArchetypeVolume>, BlockVolume, BlockVolume.Modifiable<ArchetypeVolume>, BlockVolume.Streamable<ArchetypeVolume>, EntityArchetypeVolume, EntityArchetypeVolume.Modifiable<ArchetypeVolume>, EntityArchetypeVolume.Streamable<ArchetypeVolume>, LocationBaseDataHolder, LocationBaseDataHolder.Mutable, MutableVolume, Volume

public interface Schematic
extends ArchetypeVolume, LocationBaseDataHolder.Mutable

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	Description
static interface	Schematic.Builder	A builder for Schematics.

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.biome.BiomeVolume

BiomeVolume.Immutable, BiomeVolume.Modifiable<M extends BiomeVolume.Modifiable<M>>, BiomeVolume.Mutable, BiomeVolume.Streamable<B extends BiomeVolume.Streamable<B>>, BiomeVolume.Unmodifiable<U extends BiomeVolume.Unmodifiable<U>>

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.archetype.block.entity.BlockEntityArchetypeVolume

BlockEntityArchetypeVolume.Immutable, BlockEntityArchetypeVolume.Modifiable<M extends BlockEntityArchetypeVolume.Modifiable<M>>, BlockEntityArchetypeVolume.Mutable, BlockEntityArchetypeVolume.Streamable<B extends BlockEntityArchetypeVolume.Streamable<B>>, BlockEntityArchetypeVolume.Unmodifiable<U extends BlockEntityArchetypeVolume.Unmodifiable<U>>

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.block.BlockVolume

BlockVolume.Immutable, BlockVolume.Modifiable<M extends BlockVolume.Modifiable<M>>, BlockVolume.Mutable, BlockVolume.Streamable<B extends BlockVolume.Streamable<B>>, BlockVolume.Unmodifiable<U extends BlockVolume.Unmodifiable<U>>

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.archetype.entity.EntityArchetypeVolume

EntityArchetypeVolume.Immutable, EntityArchetypeVolume.Modifiable<M extends EntityArchetypeVolume.Modifiable<M>>, EntityArchetypeVolume.Mutable, EntityArchetypeVolume.Streamable<B extends EntityArchetypeVolume.Streamable<B>>, EntityArchetypeVolume.Unmodifiable<U extends EntityArchetypeVolume.Unmodifiable<U>>

Nested classes/interfaces inherited from interface org.spongepowered.api.world.volume.game.LocationBaseDataHolder

LocationBaseDataHolder.Mutable

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Palette<Biome,Biome>	biomePalette()	Gets the Palette<BiomeType> used by this schematic for serialization.
Palette<BlockState,BlockType>	blockPalette()	Gets the Palette used by this schematic for serialization.
static Schematic.Builder	builder()	Gets a new builder for schematics.
DataView	metadata()	Gets any additional metadata attached to this schematic.

Methods inherited from interface org.spongepowered.api.world.volume.archetype.ArchetypeVolume

applyToWorld, applyToWorld, logicalCenter, transform

Methods inherited from interface org.spongepowered.api.world.volume.biome.BiomeVolume

biome, biome

Methods inherited from interface org.spongepowered.api.world.volume.biome.BiomeVolume.Modifiable

setBiome, setBiome

Methods inherited from interface org.spongepowered.api.world.volume.biome.BiomeVolume.Streamable

biomeStream

Methods inherited from interface org.spongepowered.api.world.volume.archetype.block.entity.BlockEntityArchetypeVolume

blockEntityArchetype, blockEntityArchetype, blockEntityArchetypes

Methods inherited from interface org.spongepowered.api.world.volume.archetype.block.entity.BlockEntityArchetypeVolume.Modifiable

addBlockEntity, addBlockEntity, addBlockEntity, addBlockEntity, removeBlockEntity, removeBlockEntity

Methods inherited from interface org.spongepowered.api.world.volume.archetype.block.entity.BlockEntityArchetypeVolume.Streamable

blockEntityArchetypeStream

Methods inherited from interface org.spongepowered.api.world.volume.block.BlockVolume

block, block, fluid, fluid, highestPositionAt, highestYAt, highestYAt

Methods inherited from interface org.spongepowered.api.world.volume.block.BlockVolume.Modifiable

removeBlock, removeBlock, setBlock, setBlock

Methods inherited from interface org.spongepowered.api.world.volume.block.BlockVolume.Streamable

blockStateStream

Methods inherited from interface org.spongepowered.api.world.volume.archetype.entity.EntityArchetypeVolume

entityArchetypes, entityArchetypes, entityArchetypesByPosition

Methods inherited from interface org.spongepowered.api.world.volume.archetype.entity.EntityArchetypeVolume.Modifiable

addEntity, addEntity

Methods inherited from interface org.spongepowered.api.world.volume.archetype.entity.EntityArchetypeVolume.Streamable

entitiesByPosition, entityArchetypeStream

Methods inherited from interface org.spongepowered.api.world.volume.game.LocationBaseDataHolder

get, get, get, get, getDouble, getDouble, getDouble, getDouble, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getValue, getValue, getValue, getValue, getValues, getValues, keys, keys, orElse, orElse, orElse, orElse, orElse, orElse, orElse, orElse, orNull, orNull, orNull, orNull, require, require, require, require, supports, supports, supports, supports, supports, supports

Methods inherited from interface org.spongepowered.api.world.volume.game.LocationBaseDataHolder.Mutable

copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, offer, offer, offer, offer, offer, offer, remove, remove, remove, remove, setRawData, setRawData, transform, transform, transform, transform, undo, undo, validateRawData, validateRawData

Methods inherited from interface org.spongepowered.api.world.volume.Volume

available, contains, contains, isAreaAvailable, max, min, size

Field Details

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 Details

builder

static Schematic.Builder builder()

Gets a new builder for schematics.

Returns:

The new builder

blockPalette

Palette<BlockState,BlockType> blockPalette()

Gets the Palette used by this schematic for serialization.

Specified by:

blockPalette in interface BlockVolume

Returns:

The block palette

biomePalette

Palette<Biome,Biome> biomePalette()

Gets the Palette<BiomeType> used by this schematic for serialization.

Returns:

The biome palette used for this schematic

metadata

DataView metadata()

Gets any additional metadata attached to this schematic.

Returns:

The additional metadata