org.pepsoft.worldpainter

Interface BiomeScheme

All Known Implementing Classes:

AbstractBiomeInfo, AbstractBiomeScheme, AbstractMinecraft1_1BiomeScheme, AbstractMinecraft1_20BiomeScheme, AbstractMinecraft1_2BiomeScheme, AbstractMinecraft1_7BiomeScheme, Minecraft1_10BiomeScheme, Minecraft1_10LargeBiomeScheme, Minecraft1_12BiomeInfo, Minecraft1_12BiomeScheme, Minecraft1_12JarBiomeScheme, Minecraft1_12LargeBiomeScheme, Minecraft1_17BiomeInfo, Minecraft1_1BiomeInfo, Minecraft1_1BiomeScheme, Minecraft1_2BiomeScheme, Minecraft1_2JarBiomeScheme, Minecraft1_3LargeBiomeScheme, Minecraft1_6BiomeScheme, Minecraft1_6LargeBiomeScheme, Minecraft1_7BiomeScheme, Minecraft1_7JarBiomeScheme, Minecraft1_7LargeBiomeScheme, Minecraft1_8BiomeScheme, Minecraft1_8JarBiomeScheme, Minecraft1_8LargeBiomeScheme, MinecraftJarBiomeScheme, StaticBiomeInfo

public interface BiomeScheme

A provider of Minecraft biomes information and metadata.

Method Summary

Modifier and Type	Method and Description
int	getBiomeCount() Get the number of biomes.
java.lang.String	getBiomeName(int biome) Get the name of the specified biome in this biome scheme.
int[]	getBiomes(int x, int y, int width, int height) Get the biomes for a specific rectangular area of the world.
void	getBiomes(int x, int y, int width, int height, int[] buffer) Get the biomes for a specific rectangular area of the world.
int	getColour(int biome, ColourScheme colourScheme) Get the colour of the specified biome.
boolean[][]	getPattern(int biome) The two dimensional pattern to use for painting the specified biome, if any.
default java.lang.String	getStringId(int biome) Get the technical ID of the specified biome in this biome scheme as a string.
boolean	isBiomePresent(int biome) Indicates whether the specified biome ID is present in this biome scheme.
void	setSeed(long seed) Set the seed for which to determine the biomes.

Method Detail

setSeed

void setSeed(long seed)

Set the seed for which to determine the biomes.

Parameters:

seed - The seed for which to determine the biomes.

getBiomeCount

int getBiomeCount()

Get the number of biomes. The biomes must be consecutively numbered from zero to one lower than this number, but it is permissible for there to be holes in the list.

Returns:

The number of biomes.

getBiomes

int[] getBiomes(int x,
                int y,
                int width,
                int height)

Get the biomes for a specific rectangular area of the world.

Note: the returned buffer is only valid until the next invocation of this method. If the method is invoked again the results of the buffer may be overwritten or otherwise become invalid.

Parameters:

x - The X coordinate in the WorldPainter coordinate system.

y - The Y coordinate in the WorldPainter coordinate system.

width - The width along the X axis of the area.

height - The height along the Y axis of the area.

Returns:

An array with biome information indexed first by X and then by Y coordinate.

getBiomes

void getBiomes(int x,
               int y,
               int width,
               int height,
               int[] buffer)

Get the biomes for a specific rectangular area of the world.

Parameters:

x - The X coordinate in the WorldPainter coordinate system.

y - The Y coordinate in the WorldPainter coordinate system.

width - The width along the X axis of the area.

height - The height along the Y axis of the area.

buffer - The array in which the biome information will be returned, indexed first by X and then by Y coordinate.

getColour

int getColour(int biome,
              ColourScheme colourScheme)

Get the colour of the specified biome. At its option the biome scheme may use the specified colour scheme to determine the colour, but it may also ignore it completely.

Parameters:

biome - The biome for which to determine the colour.

colourScheme - A colour scheme which the biome scheme may use, at its option, for determining the colour.

Returns:

The colour to be used for painting the specified biome in 0xRRGGBB format.

getPattern

boolean[][] getPattern(int biome)

The two dimensional pattern to use for painting the specified biome, if any. May be null. If not null, must be a 16 by 16 array of booleans, where true indicates a foreground pixel.

Parameters:

biome - The biome for which to return the pattern.

Returns:

The pattern to use for painting the specified biome, or null if no pattern should be used.

getBiomeName

java.lang.String getBiomeName(int biome)

Get the name of the specified biome in this biome scheme. This should be the human-readable name.

Parameters:

biome - The biome for which to retrieve the name.

Returns:

The name of the specified biome.

getStringId

default java.lang.String getStringId(int biome)

Get the technical ID of the specified biome in this biome scheme as a string. For Minecraft 1.20 and later this is a resource identifier (i.e. "minecraft:plains"); for earlier Minecraft versions this is the numerical ID as a string (i.e. "1").

The default implementation returns the biome parameter as a string if the biome is present; otherwise it throws a IllegalArgumentException.

Parameters:

biome - The biome for which to retrieve the name.

Returns:

The technical ID of the specified biome as a string.

isBiomePresent

boolean isBiomePresent(int biome)

Indicates whether the specified biome ID is present in this biome scheme. If this returns false, the other methods may thrown an exception if invoked for that ID.

Parameters:

biome - The biome ID to check.

Returns:

true if this biome scheme contains the specified biome.