org.pepsoft.worldpainter.biomeschemes

Class AbstractBiomeInfo

java.lang.Object

org.pepsoft.worldpainter.biomeschemes.AbstractBiomeInfo

All Implemented Interfaces:

BiomeScheme

Direct Known Subclasses:

Minecraft1_17BiomeInfo

public abstract class AbstractBiomeInfo
extends java.lang.Object
implements BiomeScheme

An abstract base class for biome info classes (BiomeScheme's which just provide static information about the supported biomes and cannot calculate biomes).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBiomeInfo(java.lang.String[] names, boolean[][][] patterns)

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.
boolean[][]	getPattern(int biome) The two dimensional pattern to use for painting the specified biome, if any.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pepsoft.worldpainter.BiomeScheme

getColour, getStringId

Constructor Detail

AbstractBiomeInfo

protected AbstractBiomeInfo(java.lang.String[] names,
                            boolean[][][] patterns)

Method Detail

setSeed

public final void setSeed(long seed)

Description copied from interface: BiomeScheme

Set the seed for which to determine the biomes.

Specified by:

setSeed in interface BiomeScheme

Parameters:

seed - The seed for which to determine the biomes.

getBiomeCount

public int getBiomeCount()

Description copied from interface: BiomeScheme

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.

Specified by:

getBiomeCount in interface BiomeScheme

Returns:

The number of biomes.

getBiomes

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

Description copied from interface: BiomeScheme

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.

Specified by:

getBiomes in interface BiomeScheme

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

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

Description copied from interface: BiomeScheme

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

Specified by:

getBiomes in interface BiomeScheme

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.

getPattern

public boolean[][] getPattern(int biome)

Description copied from interface: BiomeScheme

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.

Specified by:

getPattern in interface BiomeScheme

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

public java.lang.String getBiomeName(int biome)

Description copied from interface: BiomeScheme

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

Specified by:

getBiomeName in interface BiomeScheme

Parameters:

biome - The biome for which to retrieve the name.

Returns:

The name of the specified biome.

isBiomePresent

public boolean isBiomePresent(int biome)

Description copied from interface: BiomeScheme

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.

Specified by:

isBiomePresent in interface BiomeScheme

Parameters:

biome - The biome ID to check.

Returns:

true if this biome scheme contains the specified biome.