org.spongepowered.api.world.schematic

Interface Schematic.Builder

All Superinterfaces:

ResettableBuilder<Schematic,Schematic.Builder>

Enclosing interface:

Schematic

public static interface Schematic.Builder
extends ResettableBuilder<Schematic,Schematic.Builder>

A builder for Schematics.

Method Summary

Modifier and Type	Method and Description
default Schematic.Builder	biomePalette(Palette<BiomeType> palette) Specifies a palette for the schemtic to use for serialization.
default Schematic.Builder	biomePaletteType(PaletteType<BiomeType> type) Specifies the palette type to use for biomes if the biomePalette(Palette) is not specified.
default Schematic.Builder	blockPalette(Palette<BlockState> palette) Specifies a palette for the schematic to use for serialization.
default Schematic.Builder	blockPaletteType(PaletteType<BlockState> type) Specifies the palette type to use if the palette(org.spongepowered.api.world.schematic.BlockPalette) is not specified.
Schematic	build() Constructs a new Schematic from this builder.
default Schematic.Builder	entities(Collection<EntityArchetype> entities)
default Schematic.Builder	entity(EntityArchetype entityArchetype)
default Schematic.Builder	entity(EntityArchetype entityArchetype, com.flowpowered.math.vector.Vector3d position)
Schematic.Builder	metadata(DataView metadata) Specifies the metadata container.
Schematic.Builder	metaValue(String key, Object value) Specifies a metadata value which will be included in the metadata of the schematic.
Schematic.Builder	palette(BlockPalette palette) Deprecated. Use blockPalette(Palette)
Schematic.Builder	paletteType(BlockPaletteType type) Deprecated. Use blockPaletteType(PaletteType)
Schematic.Builder	volume(ArchetypeVolume volume) Specifies an archetype volume for the world data of the schematic.
Schematic.Builder	volume(Extent volume) Specifies an extent view for the schematic to load its world data from.

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

from, reset

Method Detail

volume

Schematic.Builder volume(ArchetypeVolume volume)

Specifies an archetype volume for the world data of the schematic.

If purely creating a schematic it is recommended to instead use the volume(Extent) method and pass in an extent view (See Extent.getExtentView(com.flowpowered.math.vector.Vector3i, com.flowpowered.math.vector.Vector3i)) of the volume to prevent creating multiple copies of the world data. Likewise, if BiomeTypes are needed to be copied, only volume(Extent) will support copying the BiomeTypes at the desired positions. This also has the same limit for capturing EntityArchetypes, unless otherwise manually placed in with entity(EntityArchetype).

Parameters:

volume - The archetype volume

Returns:

This builder, for chaining

volume

Schematic.Builder volume(Extent volume)

Specifies an extent view for the schematic to load its world data from.

Parameters:

volume - The extent view

Returns:

This builder, for chaining

palette

@Deprecated
Schematic.Builder palette(BlockPalette palette)

Deprecated. Use blockPalette(Palette)

Specifies a palette for the schematic to use for serialization. This overrides the paletteType(org.spongepowered.api.world.schematic.BlockPaletteType) value.

Parameters:

palette - The palette to use for serialization

Returns:

This builder, for chaining

blockPalette

default Schematic.Builder blockPalette(Palette<BlockState> palette)

Specifies a palette for the schematic to use for serialization. This overrides the paletteType(org.spongepowered.api.world.schematic.BlockPaletteType) value.

Parameters:

palette - The palette to use for serialization

Returns:

This builder, for chaining

biomePalette

default Schematic.Builder biomePalette(Palette<BiomeType> palette)

Specifies a palette for the schemtic to use for serialization.

Parameters:

palette - The palette to use for serialization

Returns:

This builder, for chaining

paletteType

@Deprecated
Schematic.Builder paletteType(BlockPaletteType type)

Deprecated. Use blockPaletteType(PaletteType)

Specifies the palette type to use if the palette(org.spongepowered.api.world.schematic.BlockPalette) is not specified.

Parameters:

type - The palette type

Returns:

This builder, for chaining

blockPaletteType

default Schematic.Builder blockPaletteType(PaletteType<BlockState> type)

Specifies the palette type to use if the palette(org.spongepowered.api.world.schematic.BlockPalette) is not specified.

Parameters:

type - The palette type

Returns:

This builder, for chaining

biomePaletteType

default Schematic.Builder biomePaletteType(PaletteType<BiomeType> type)

Specifies the palette type to use for biomes if the biomePalette(Palette) is not specified.

Parameters:

type - The type of biome palette

Returns:

This builder, for chaining

entity

default Schematic.Builder entity(EntityArchetype entityArchetype)

entity

default Schematic.Builder entity(EntityArchetype entityArchetype,
                                 com.flowpowered.math.vector.Vector3d position)

entities

default Schematic.Builder entities(Collection<EntityArchetype> entities)

metadata

Schematic.Builder metadata(DataView metadata)

Specifies the metadata container.

Parameters:

metadata - The metadata container

Returns:

This builder, for chaining

metaValue

Schematic.Builder metaValue(String key,
                            Object value)

Specifies a metadata value which will be included in the metadata of the schematic.

Parameters:

key - The metadata key

value - The value

Returns:

This builder, for chaining

build

Schematic build()
         throws IllegalArgumentException

Constructs a new Schematic from this builder.

Returns:

The new schematic

Throws:

IllegalArgumentException - If any required data was not specified