org.spongepowered.api.world.extent

Interface MutableBlockVolume

All Superinterfaces:

BlockVolume

All Known Subinterfaces:

ArchetypeVolume, Chunk, Extent, InteractableVolume, Schematic, TileEntityVolume, World

public interface MutableBlockVolume
extends BlockVolume

A volume containing blocks that can be accessed and modified.

See Also:

BlockVolume

Method Summary

Modifier and Type	Method and Description
MutableBlockVolume	getBlockView(DiscreteTransform3 transform) Returns a new volume that is viewed through some transformation.
MutableBlockVolume	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.
MutableBlockVolumeWorker<? extends MutableBlockVolume>	getBlockWorker() Gets a new block worker for this block volume.
default MutableBlockVolume	getRelativeBlockView() Returns a new volume that is translated so that BlockVolume.getBlockMin() returns Vector3i.ZERO.
boolean	setBlock(int x, int y, int z, BlockState block) Sets the block at the given position in the world.
default boolean	setBlock(com.flowpowered.math.vector.Vector3i position, BlockState block) Sets the block at the given position in the world.
default boolean	setBlockType(int x, int y, int z, BlockType type) Replace the block at this position by a new type.
default boolean	setBlockType(com.flowpowered.math.vector.Vector3i position, BlockType type) Replace the block at this position by a new type.

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

setBlock

default boolean setBlock(com.flowpowered.math.vector.Vector3i position,
                         BlockState block)

Sets the block at the given position in the world.

Parameters:

position - The position

block - The block

Returns:

Whether the block change was successful

Throws:

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

setBlock

boolean setBlock(int x,
                 int y,
                 int z,
                 BlockState block)

Sets the block at the given position in the world.

Parameters:

x - The X position

y - The Y position

z - The Z position

block - The block

Returns:

Whether the block change was successful

Throws:

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

setBlockType

default boolean setBlockType(com.flowpowered.math.vector.Vector3i position,
                             BlockType type)

Replace the block at this position by a new type.

This will remove any extended block data at the given position.

Parameters:

position - The position of the block

type - The new type

Returns:

Whether the block change was successful

Throws:

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

setBlockType

default boolean setBlockType(int x,
                             int y,
                             int z,
                             BlockType type)

Replace the block at this position by a new type.

This will remove any extended block data at the given position.

Parameters:

x - The X position

y - The Y position

z - The Z position

type - The new type

Returns:

Whether the block change was successful

Throws:

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

getBlockView

MutableBlockVolume 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.

Specified by:

getBlockView in interface BlockVolume

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

MutableBlockVolume 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.

Specified by:

getBlockView in interface BlockVolume

Parameters:

transform - The transformation to be applied

Returns:

The new volume with the transform

getRelativeBlockView

default MutableBlockVolume getRelativeBlockView()

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

Specified by:

getRelativeBlockView in interface BlockVolume

Returns:

The new volume with its minimum at zero

getBlockWorker

MutableBlockVolumeWorker<? extends MutableBlockVolume> getBlockWorker()

Description copied from interface: BlockVolume

Gets a new block worker for this block volume.

Specified by:

getBlockWorker in interface BlockVolume

Returns:

The block worker