org.spongepowered.api.world.extent

Interface TileEntityVolume

All Superinterfaces:

BlockVolume, MutableBlockVolume

All Known Subinterfaces:

Chunk, Extent, World

public interface TileEntityVolume
extends MutableBlockVolume

A mutable block volume that also contains TileEntity instances.

Method Summary

Modifier and Type	Method and Description
MutableBlockVolumeWorker<? extends TileEntityVolume>	getBlockWorker() Gets a new block worker for this block volume.
Collection<TileEntity>	getTileEntities() Return a collection of tile entities contained within this volume, possibly only returning tile entities only in loaded areas.
Collection<TileEntity>	getTileEntities(Predicate<TileEntity> filter) Return a collection of tile entities contained within this volume, possibly only returning tile entities only in loaded areas.
Optional<TileEntity>	getTileEntity(int x, int y, int z) Gets the tile entity at the given position, if it exists.
default Optional<TileEntity>	getTileEntity(com.flowpowered.math.vector.Vector3i position) Gets the tile entity at the given position, if it exists.

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

getTileEntities

Collection<TileEntity> getTileEntities()

Return a collection of tile entities contained within this volume, possibly only returning tile entities only in loaded areas.

For world implementations, only some parts of the world is usually loaded, so this method will only return tile entities within those loaded parts.

Returns:

A collection of entities

getTileEntities

Collection<TileEntity> getTileEntities(Predicate<TileEntity> filter)

Return a collection of tile entities contained within this volume, possibly only returning tile entities only in loaded areas. The returned tile entities are filtered by the given Predicate before being returned.

For world implementations, only some parts of the world is usually loaded, so this method will only return tile entities within those loaded parts.

Parameters:

filter - The filter to apply to the returned entities

Returns:

A collection of filtered entities

getTileEntity

default Optional<TileEntity> getTileEntity(com.flowpowered.math.vector.Vector3i position)

Gets the tile entity at the given position, if it exists.

Parameters:

position - The position

Returns:

The tile entity, or Optional.empty()

getTileEntity

Optional<TileEntity> getTileEntity(int x,
                                   int y,
                                   int z)

Gets the tile entity at the given position, if it exists.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The tile entity, or Optional.empty()

getBlockWorker

MutableBlockVolumeWorker<? extends TileEntityVolume> 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