Package org.spongepowered.api.world.volume.biome

Interface BiomeVolume

All Superinterfaces:

Volume

All Known Subinterfaces:

ArchetypeVolume, BiomeVolume.Immutable, BiomeVolume.Modifiable<M>, BiomeVolume.Mutable, BiomeVolume.Streamable<B>, BiomeVolume.Unmodifiable<U>, Chunk<P>, ClientWorld, EnvironmentalVolume, GenerationChunk, GenerationRegion, Region<R>, Schematic, ServerWorld, Virtualized.Immutable, World<W,L>, WorldChunk, WorldLike<P>

public interface BiomeVolume
extends Volume

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BiomeVolume.Immutable
static interface	BiomeVolume.Modifiable<M extends BiomeVolume.Modifiable<M>>
static interface	BiomeVolume.Mutable
static interface	BiomeVolume.Streamable<B extends BiomeVolume.Streamable<B>>
static interface	BiomeVolume.Unmodifiable<U extends BiomeVolume.Unmodifiable<U>>	Like a BlockVolume except in the case that while the parent volume can potentially be a MutableVolume, this volume returned will not be.

Method Summary

Modifier and Type	Method	Description
Biome	biome(int x, int y, int z)	Gets the Biome at the given location.
default Biome	biome(Vector3i position)	Gets an object representing the biome at the given position.

Methods inherited from interface org.spongepowered.api.world.volume.Volume

available, contains, contains, isAreaAvailable, max, min, size

Method Detail

biome

default Biome biome(Vector3i position)

Gets an object representing the biome at the given position.

Parameters:

position - The position

Returns:

The biome

Throws:

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

biome

Biome biome(int x,
            int y,
            int z)

Gets the Biome at the given location.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The biome

Throws:

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