org.spongepowered.api.world.extent

Interface MutableBiomeVolume

All Superinterfaces:

BiomeVolume

All Known Subinterfaces:

Chunk, Extent, World

public interface MutableBiomeVolume
extends BiomeVolume

A volume containing biomes that can be accessed and modified.

See Also:

BiomeVolume

Method Summary

Modifier and Type	Method and Description
MutableBiomeVolume	getBiomeView(DiscreteTransform3 transform) Returns a new volume that is viewed through some transformation.
MutableBiomeVolume	getBiomeView(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.
MutableBiomeVolumeWorker<? extends MutableBiomeVolume>	getBiomeWorker() Gets a new biome worker for this biome volume.
default MutableBiomeVolume	getRelativeBiomeView() Returns a new volume that is translated so that BiomeVolume.getBiomeMin() returns Vector3i.ZERO.
void	setBiome(int x, int y, int z, BiomeType biome) Sets the biome at the given position in the world.
default void	setBiome(com.flowpowered.math.vector.Vector3i position, BiomeType biome) Sets the biome at the given position in the world.

Methods inherited from interface org.spongepowered.api.world.extent.BiomeVolume

containsBiome, containsBiome, getBiome, getBiome, getBiomeCopy, getBiomeCopy, getBiomeMax, getBiomeMin, getBiomeSize, getImmutableBiomeCopy, getUnmodifiableBiomeView

Method Detail

setBiome

default void setBiome(com.flowpowered.math.vector.Vector3i position,
                      BiomeType biome)

Sets the biome at the given position in the world.

Parameters:

position - The position

biome - The biome

Throws:

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

setBiome

void setBiome(int x,
              int y,
              int z,
              BiomeType biome)

Sets the biome at the given position in the world.

Parameters:

x - The X position

y - The Y position

z - The Z position

biome - The biome

Throws:

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

getBiomeView

MutableBiomeVolume getBiomeView(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 biomes, it only provides a new view of the storage.

Specified by:

getBiomeView in interface BiomeVolume

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

getBiomeView

MutableBiomeVolume getBiomeView(DiscreteTransform3 transform)

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

Specified by:

getBiomeView in interface BiomeVolume

Parameters:

transform - The transformation to be applied

Returns:

The new volume with the transform

getRelativeBiomeView

default MutableBiomeVolume getRelativeBiomeView()

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

Specified by:

getRelativeBiomeView in interface BiomeVolume

Returns:

The new volume with its minimum at zero

getBiomeWorker

MutableBiomeVolumeWorker<? extends MutableBiomeVolume> getBiomeWorker()

Description copied from interface: BiomeVolume

Gets a new biome worker for this biome volume.

Specified by:

getBiomeWorker in interface BiomeVolume

Returns:

The biome worker