BiomeVolume (SpongeAPI 7.3.0 API)

All Known Subinterfaces:

Chunk, Extent, ImmutableBiomeVolume, MutableBiomeVolume, UnmodifiableBiomeVolume, World
```
public interface BiomeVolume
```
A volume containing biomes that can be at least accessed.
In vanilla, the y coordinate is always zero.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`containsBiome(int x, int y, int z)` Returns true if the biome volume contains a biome at the specified position.
`default boolean`	`containsBiome(com.flowpowered.math.vector.Vector3i position)` Returns true if the biome volume contains a biome at the specified position.
`BiomeType`	`getBiome(int x, int y, int z)` Gets the `BiomeType` at the given location.
`default BiomeType`	`getBiome(com.flowpowered.math.vector.Vector3i position)` Gets an object representing the biome at the given position.
`default MutableBiomeVolume`	`getBiomeCopy()` Returns a mutable copy of the biomes stored in this volume.
`MutableBiomeVolume`	`getBiomeCopy(StorageType type)` Returns a mutable copy of the biomes stored in this volume.
`com.flowpowered.math.vector.Vector3i`	`getBiomeMax()` Gets the biome location with the highest x and y that is still a valid position for `getBiome(Vector3i)`.
`com.flowpowered.math.vector.Vector3i`	`getBiomeMin()` Gets the biome location with the lowest x and y that is still a valid position for `getBiome(Vector3i)`.
`com.flowpowered.math.vector.Vector3i`	`getBiomeSize()` Gets the size of the volume.
`BiomeVolume`	`getBiomeView(DiscreteTransform3 transform)` Returns a new volume that is viewed through some transformation.
`BiomeVolume`	`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.
`BiomeVolumeWorker<? extends BiomeVolume>`	`getBiomeWorker()` Gets a new biome worker for this biome volume.
`ImmutableBiomeVolume`	`getImmutableBiomeCopy()` Returns an immutable copy of the biomes stored in this volume.
`default BiomeVolume`	`getRelativeBiomeView()` Returns a new volume that is translated so that `getBiomeMin()` returns `Vector3i.ZERO`.
`UnmodifiableBiomeVolume`	`getUnmodifiableBiomeView()` Returns a new volume that cannot be modified through this view.

- Method Detail
  - getBiomeMin
```
com.flowpowered.math.vector.Vector3i getBiomeMin()
```
    Gets the biome location with the lowest x and y that is still a valid position for getBiome(Vector3i).
    
    Returns:
    
    The lowest biome location
  - getBiomeMax
```
com.flowpowered.math.vector.Vector3i getBiomeMax()
```
    Gets the biome location with the highest x and y that is still a valid position for getBiome(Vector3i).
    
    Returns:
    
    The highest biome location.
  - getBiomeSize
```
com.flowpowered.math.vector.Vector3i getBiomeSize()
```
    Gets the size of the volume. Defined as getBiomeMax() - getBiomeMin() + (1, 1).
    
    Returns:
    
    The size
  - containsBiome
```
default boolean containsBiome(com.flowpowered.math.vector.Vector3i position)
```
    Returns true if the biome volume contains a biome at the specified position. This is defined as {getBiomeMin() <= position <= getBiomeMax()
    
    Parameters:
    
    position - The position to check
    
    Returns:
    
    Whether or not the position has a biome in this volume
  - containsBiome
```
boolean containsBiome(int x,
                      int y,
                      int z)
```
    Returns true if the biome volume contains a biome at the specified position. This is defined as {getBiomeMin() <= (x, y, z) <= getBiomeMax()
    
    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 biome in this volume
  - getBiome
```
default BiomeType getBiome(com.flowpowered.math.vector.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
  - getBiome
```
BiomeType getBiome(int x,
                   int y,
                   int z)
```
    Gets the BiomeType 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
  - getBiomeView
```
BiomeVolume 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.
    
    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
```
BiomeVolume 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.
    
    Parameters:
    
    transform - The transformation to be applied
    
    Returns:
    
    The new volume with the transform
  - getRelativeBiomeView
```
default BiomeVolume getRelativeBiomeView()
```
    Returns a new volume that is translated so that getBiomeMin() returns Vector3i.ZERO. This does not copy the biomes, it only provides a new view of the storage.
    
    Returns:
    
    The new volume with its minimum at zero
  - getUnmodifiableBiomeView
```
UnmodifiableBiomeVolume getUnmodifiableBiomeView()
```
    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 biomes, it only provides a new view of the storage.
    
    Returns:
    
    The new volume, which cannot be modified
  - getBiomeCopy
```
default MutableBiomeVolume getBiomeCopy()
```
    Returns a mutable copy of the biomes stored in this volume. This uses the default storage type of StorageType.STANDARD.
    
    Returns:
    
    A copy of the biomes
  - getBiomeCopy
```
MutableBiomeVolume getBiomeCopy(StorageType type)
```
    Returns a mutable copy of the biomes stored in this volume. This uses the provided storage type.
    
    Parameters:
    
    type - The type of storage used by the new biomes
    
    Returns:
    
    A copy of the biomes
  - getImmutableBiomeCopy
```
ImmutableBiomeVolume getImmutableBiomeCopy()
```
    Returns an immutable copy of the biomes stored in this volume. This uses some internal storage solution that is thread-safe by nature.
    
    Returns:
    
    An immutable copy of the biomes
  - getBiomeWorker
```
BiomeVolumeWorker<? extends BiomeVolume> getBiomeWorker()
```
    Gets a new biome worker for this biome volume.
    
    Returns:
    
    The biome worker

Interface BiomeVolume

Method Summary

Method Detail

getBiomeMin

getBiomeMax

getBiomeSize

containsBiome

containsBiome

getBiome

getBiome

getBiomeView

getBiomeView

getRelativeBiomeView

getUnmodifiableBiomeView

getBiomeCopy

getBiomeCopy

getImmutableBiomeCopy

getBiomeWorker