org.spongepowered.api.world.extent

Interface BlockVolume

All Known Subinterfaces:

ArchetypeVolume, Chunk, Extent, ImmutableBlockVolume, InteractableVolume, MutableBlockVolume, Schematic, TileEntityVolume, UnmodifiableBlockVolume, World

public interface BlockVolume

A volume containing blocks that can be at least accessed.

Method Summary

Modifier and Type	Method and Description
boolean	containsBlock(int x, int y, int z) Returns true if the block volume contains a block at the specified position.
default boolean	containsBlock(com.flowpowered.math.vector.Vector3i position) Returns true if the block volume contains a block at the specified position.
BlockState	getBlock(int x, int y, int z) Gets a representation of the block at the given position.
default BlockState	getBlock(com.flowpowered.math.vector.Vector3i position) Gets a representation of the block at the given position.
default MutableBlockVolume	getBlockCopy() Returns a mutable copy of the blocks stored in this volume.
MutableBlockVolume	getBlockCopy(StorageType type) Returns a mutable copy of the blocks stored in this volume.
com.flowpowered.math.vector.Vector3i	getBlockMax() Gets the block location with the highest x, y and z that is still a valid position for getBlock(Vector3i).
com.flowpowered.math.vector.Vector3i	getBlockMin() Gets the block location with the lowest x, y and z that is still a valid position for getBlock(Vector3i).
com.flowpowered.math.vector.Vector3i	getBlockSize() Gets the size of the whole volume.
BlockType	getBlockType(int x, int y, int z) Gets the base type of block.
default BlockType	getBlockType(com.flowpowered.math.vector.Vector3i position) Gets the base type of block.
BlockVolume	getBlockView(DiscreteTransform3 transform) Returns a new volume that is viewed through some transformation.
BlockVolume	getBlockView(com.flowpowered.math.vector.Vector3i newMin, com.flowpowered.math.vector.Vector3i newMax) Returns a new volume that is the same or smaller than the current volume.
BlockVolumeWorker<? extends BlockVolume>	getBlockWorker() Gets a new block worker for this block volume.
ImmutableBlockVolume	getImmutableBlockCopy() Returns an immutable copy of the blocks stored in this volume.
default BlockVolume	getRelativeBlockView() Returns a new volume that is translated so that getBlockMin() returns Vector3i.ZERO.
UnmodifiableBlockVolume	getUnmodifiableBlockView() Returns a new volume that cannot be modified through this view.

Method Detail

getBlockMin

com.flowpowered.math.vector.Vector3i getBlockMin()

Gets the block location with the lowest x, y and z that is still a valid position for getBlock(Vector3i).

Returns:

The lowest block location

getBlockMax

com.flowpowered.math.vector.Vector3i getBlockMax()

Gets the block location with the highest x, y and z that is still a valid position for getBlock(Vector3i).

Returns:

The highest block location

getBlockSize

com.flowpowered.math.vector.Vector3i getBlockSize()

Gets the size of the whole volume. Defined as getBlockMax() - getBlockMin() + (1, 1, 1) .

Returns:

The size

containsBlock

default boolean containsBlock(com.flowpowered.math.vector.Vector3i position)

Returns true if the block volume contains a block at the specified position. This is defined as {getBlockMin() <= position <= getBlockMax()

Parameters:

position - The position to check

Returns:

Whether or not the position has a block in this volume

containsBlock

boolean containsBlock(int x,
                      int y,
                      int z)

Returns true if the block volume contains a block at the specified position. This is defined as {getBlockMin() <= (x, y, z) <= getBlockMax()

Parameters:

x - The X coordinate to check

y - The Y coordinate to check

z - The Z coordinate to check

Returns:

Whether or not the position has a block in this volume

getBlock

default BlockState getBlock(com.flowpowered.math.vector.Vector3i position)

Gets a representation of the block at the given position.

Parameters:

position - The position

Returns:

The block

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

getBlock

BlockState getBlock(int x,
                    int y,
                    int z)

Gets a representation of the block at the given position.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The block

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

getBlockType

default BlockType getBlockType(com.flowpowered.math.vector.Vector3i position)

Gets the base type of block.

The type does not include block data such as the contents of inventories.

Parameters:

position - The position of the block

Returns:

The type of block

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the block volume

getBlockType

BlockType getBlockType(int x,
                       int y,
                       int z)

Gets the base type of block.

The type does not include block data such as the contents of inventories.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The type of block

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the block volume

getBlockView

BlockVolume getBlockView(com.flowpowered.math.vector.Vector3i newMin,
                         com.flowpowered.math.vector.Vector3i newMax)

Returns a new volume that is the same or smaller than the current volume. This does not copy the blocks, it only provides a new view of the storage.

Parameters:

newMin - The new minimum coordinates in this volume

newMax - The new maximum coordinates in this volume

Returns:

The new volume with the new bounds

Throws:

PositionOutOfBoundsException - If the new minimum and maximum are outside the current volume

getBlockView

BlockVolume getBlockView(DiscreteTransform3 transform)

Returns a new volume that is viewed through some transformation. This does not copy the blocks, it only provides a new view of the storage.

Parameters:

transform - The transformation to be applied

Returns:

The new volume with the transform

getRelativeBlockView

default BlockVolume getRelativeBlockView()

Returns a new volume that is translated so that getBlockMin() returns Vector3i.ZERO. This does not copy the blocks, it only provides a new view of the storage.

Returns:

The new volume with its minimum at zero

getUnmodifiableBlockView

UnmodifiableBlockVolume getUnmodifiableBlockView()

Returns a new volume that cannot be modified through this view. Unlike immutable storage, it can be changed by holders of mutable views. This does not copy the blocks, it only provides a new view of the storage.

Returns:

The new volume, which cannot be modified

getBlockCopy

default MutableBlockVolume getBlockCopy()

Returns a mutable copy of the blocks stored in this volume. This uses the default storage type of StorageType.STANDARD.

Returns:

A copy of the blocks

getBlockCopy

MutableBlockVolume getBlockCopy(StorageType type)

Returns a mutable copy of the blocks stored in this volume. This uses the provided storage type.

Parameters:

type - The type of storage used by the new blocks

Returns:

A copy of the blocks

getImmutableBlockCopy

ImmutableBlockVolume getImmutableBlockCopy()

Returns an immutable copy of the blocks stored in this volume. This uses some internal storage solution that is thread-safe by nature.

Returns:

An immutable copy of the blocks

getBlockWorker

BlockVolumeWorker<? extends BlockVolume> getBlockWorker()

Gets a new block worker for this block volume.

Returns:

The block worker