tff.reid.api

Interface BiomeApi

public interface BiomeApi

API class to provide utility methods to easily read & write extended biomes in RoughlyEnoughIDs format.

Field Summary

Fields

Modifier and Type	Field and Description
static BiomeApi	INSTANCE The BiomeApi service.

Method Summary

Modifier and Type	Method and Description
void	fillWithBiome(net.minecraft.world.chunk.Chunk chunk, int biomeId) Fills the entire chunk with a single biome.
BiomeAccessor	getBiomeAccessor(net.minecraft.world.chunk.Chunk chunk) Returns a BiomeAccessor from the specified chunk, used to read biomes.
int	getIdentityMask() Returns the value that serves as an identity mask for the maximum number of biomes RoughlyEnoughIDs supports.
int	getMaxBiomeId() Returns the maximum biome id supported by RoughlyEnoughIDs.
void	replaceBiomes(net.minecraft.world.chunk.Chunk chunk, net.minecraft.world.biome.Biome[] biomes) Updates all biomes in the specified chunk.
void	replaceBiomes(net.minecraft.world.chunk.Chunk chunk, int[] biomeIds) Updates all biomes in the specified chunk.
void	updateBiome(net.minecraft.world.chunk.Chunk chunk, net.minecraft.util.math.BlockPos pos, int biomeId) Updates a biome at a single position within the specified chunk.

Field Detail

INSTANCE

static final BiomeApi INSTANCE

The BiomeApi service.

Method Detail

getBiomeAccessor

BiomeAccessor getBiomeAccessor(net.minecraft.world.chunk.Chunk chunk)

Returns a BiomeAccessor from the specified chunk, used to read biomes.

Parameters:

chunk - the chunk

Returns:

a BiomeAccessor of the chunk

updateBiome

void updateBiome(net.minecraft.world.chunk.Chunk chunk,
                 net.minecraft.util.math.BlockPos pos,
                 int biomeId)

Updates a biome at a single position within the specified chunk.

Parameters:

chunk - the chunk

pos - the position of the biome to change

biomeId - the id of the biome

Throws:

java.lang.IllegalArgumentException - if pos is not within the chunk

replaceBiomes

void replaceBiomes(net.minecraft.world.chunk.Chunk chunk,
                   int[] biomeIds)

Updates all biomes in the specified chunk.

Parameters:

chunk - the chunk

biomeIds - an array of biome ids to replace the chunk's array with.

Throws:

java.lang.IllegalArgumentException - if biomeIds does not match the length of the chunk's array

replaceBiomes

void replaceBiomes(net.minecraft.world.chunk.Chunk chunk,
                   net.minecraft.world.biome.Biome[] biomes)

Updates all biomes in the specified chunk.

Parameters:

chunk - the chunk

biomes - an array of biomes to replace the chunk's array with

Throws:

java.lang.IllegalArgumentException - if biomes does not match the length of the chunk's array

fillWithBiome

void fillWithBiome(net.minecraft.world.chunk.Chunk chunk,
                   int biomeId)

Fills the entire chunk with a single biome.

Parameters:

chunk - the chunk

biomeId - the id of the biome to fill the chunk with.

getIdentityMask

int getIdentityMask()

Returns the value that serves as an identity mask for the maximum number of biomes RoughlyEnoughIDs supports. Generally for use in GenLayer masking.

Returns:

the identity mask

getMaxBiomeId

int getMaxBiomeId()

Returns the maximum biome id supported by RoughlyEnoughIDs.

Returns:

the max biome id