org.spongepowered.api.world.extent

Interface ArchetypeVolume

All Superinterfaces:

BlockVolume, MutableBlockVolume

All Known Subinterfaces:

Schematic

public interface ArchetypeVolume
extends MutableBlockVolume

A copy of a region taken from another extent.

Method Summary

Modifier and Type	Method and Description
void	apply(Location<World> location, BlockChangeFlag changeFlag) Applies this archetype at the given location.
MutableBlockVolumeWorker<? extends ArchetypeVolume>	getBlockWorker() Gets a new block worker for this block volume.
default ListMultimap<com.flowpowered.math.vector.Vector3d,EntityArchetype>	getEntitiesByPosition()
default Optional<EntityArchetype>	getEntityArchetype(double x, double y, double z)
default Collection<EntityArchetype>	getEntityArchetypes()
Optional<TileEntityArchetype>	getTileEntityArchetype(int x, int y, int z) Gets the TileEntityArchetype for the tile entity carrying block at the given coordinates.
default Optional<TileEntityArchetype>	getTileEntityArchetype(com.flowpowered.math.vector.Vector3i position) Gets the TileEntityArchetype for the tile entity carrying block at the given coordinates.
Map<com.flowpowered.math.vector.Vector3i,TileEntityArchetype>	getTileEntityArchetypes() Gets a map containing all tile entity archetypes within this volume, keyed by their positions within the volume.

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

Method Detail

apply

void apply(Location<World> location,
           BlockChangeFlag changeFlag)

Applies this archetype at the given location. The archetype will be mapped onto the given world such that the origin on the archetype lines up with the given position.

Parameters:

location - The location to apply at

changeFlag - The flag to use for toggling various operations on block placement

getTileEntityArchetype

Optional<TileEntityArchetype> getTileEntityArchetype(int x,
                                                     int y,
                                                     int z)

Gets the TileEntityArchetype for the tile entity carrying block at the given coordinates.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The tile entity, if found

getTileEntityArchetype

default Optional<TileEntityArchetype> getTileEntityArchetype(com.flowpowered.math.vector.Vector3i position)

Gets the TileEntityArchetype for the tile entity carrying block at the given coordinates.

Parameters:

position - The position

Returns:

The tile entity, if found

getTileEntityArchetypes

Map<com.flowpowered.math.vector.Vector3i,TileEntityArchetype> getTileEntityArchetypes()

Gets a map containing all tile entity archetypes within this volume, keyed by their positions within the volume.

Returns:

The tile entity map

getEntityArchetype

default Optional<EntityArchetype> getEntityArchetype(double x,
                                                     double y,
                                                     double z)

getEntitiesByPosition

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

getEntityArchetypes

default Collection<EntityArchetype> getEntityArchetypes()

getBlockWorker

MutableBlockVolumeWorker<? extends ArchetypeVolume> getBlockWorker()

Description copied from interface: BlockVolume

Gets a new block worker for this block volume.

Specified by:

getBlockWorker in interface BlockVolume

Specified by:

getBlockWorker in interface MutableBlockVolume

Returns:

The block worker