org.pepsoft.worldpainter.biomeschemes

Class AbstractMinecraft1_1BiomeScheme

java.lang.Object

org.pepsoft.worldpainter.biomeschemes.AbstractBiomeScheme

org.pepsoft.worldpainter.biomeschemes.AbstractMinecraft1_1BiomeScheme

All Implemented Interfaces:

BiomeScheme

Direct Known Subclasses:

Minecraft1_1BiomeInfo, MinecraftJarBiomeScheme

public abstract class AbstractMinecraft1_1BiomeScheme
extends AbstractBiomeScheme

An abstract base class for BiomeSchemes which provide the biomes as used in Minecraft 1.1.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIOME_BEACH
static int	BIOME_DESERT
static int	BIOME_DESERT_HILLS
static int	BIOME_EXTREME_HILLS
static int	BIOME_EXTREME_HILLS_EDGE
static int	BIOME_FOREST
static int	BIOME_FOREST_HILLS
static int	BIOME_FROZEN_OCEAN
static int	BIOME_FROZEN_RIVER
static int	BIOME_HELL
static int	BIOME_ICE_MOUNTAINS
static int	BIOME_ICE_PLAINS
static int	BIOME_MUSHROOM_ISLAND
static int	BIOME_MUSHROOM_ISLAND_SHORE
static java.lang.String[]	BIOME_NAMES
static int	BIOME_OCEAN
static int	BIOME_PLAINS
static int	BIOME_RIVER
static int	BIOME_SKY
static int	BIOME_SWAMPLAND
static int	BIOME_TAIGA
static int	BIOME_TAIGA_HILLS

Constructor Summary

Constructors

Constructor and Description
AbstractMinecraft1_1BiomeScheme()

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	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.
boolean	isBiomePresent(int biome) Indicates whether the specified biome ID is present in this biome scheme.

Methods inherited from class org.pepsoft.worldpainter.biomeschemes.AbstractBiomeScheme

getBiomes

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

getBiomes, getStringId, setSeed

Field Detail

BIOME_OCEAN

public static final int BIOME_OCEAN

See Also:

Constant Field Values

BIOME_PLAINS

public static final int BIOME_PLAINS

See Also:

Constant Field Values

BIOME_DESERT

public static final int BIOME_DESERT

See Also:

Constant Field Values

BIOME_EXTREME_HILLS

public static final int BIOME_EXTREME_HILLS

See Also:

Constant Field Values

BIOME_FOREST

public static final int BIOME_FOREST

See Also:

Constant Field Values

BIOME_TAIGA

public static final int BIOME_TAIGA

See Also:

Constant Field Values

BIOME_SWAMPLAND

public static final int BIOME_SWAMPLAND

See Also:

Constant Field Values

BIOME_RIVER

public static final int BIOME_RIVER

See Also:

Constant Field Values

BIOME_HELL

public static final int BIOME_HELL

See Also:

Constant Field Values

BIOME_SKY

public static final int BIOME_SKY

See Also:

Constant Field Values

BIOME_FROZEN_OCEAN

public static final int BIOME_FROZEN_OCEAN

See Also:

Constant Field Values

BIOME_FROZEN_RIVER

public static final int BIOME_FROZEN_RIVER

See Also:

Constant Field Values

BIOME_ICE_PLAINS

public static final int BIOME_ICE_PLAINS

See Also:

Constant Field Values

BIOME_ICE_MOUNTAINS

public static final int BIOME_ICE_MOUNTAINS

See Also:

Constant Field Values

BIOME_MUSHROOM_ISLAND

public static final int BIOME_MUSHROOM_ISLAND

See Also:

Constant Field Values

BIOME_MUSHROOM_ISLAND_SHORE

public static final int BIOME_MUSHROOM_ISLAND_SHORE

See Also:

Constant Field Values

BIOME_BEACH

public static final int BIOME_BEACH

See Also:

Constant Field Values

BIOME_DESERT_HILLS

public static final int BIOME_DESERT_HILLS

See Also:

Constant Field Values

BIOME_FOREST_HILLS

public static final int BIOME_FOREST_HILLS

See Also:

Constant Field Values

BIOME_TAIGA_HILLS

public static final int BIOME_TAIGA_HILLS

See Also:

Constant Field Values

BIOME_EXTREME_HILLS_EDGE

public static final int BIOME_EXTREME_HILLS_EDGE

See Also:

Constant Field Values

BIOME_NAMES

public static final java.lang.String[] BIOME_NAMES

Constructor Detail

AbstractMinecraft1_1BiomeScheme

public AbstractMinecraft1_1BiomeScheme()

Method Detail

getBiomeCount

public final 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.

Returns:

The number of biomes.

getColour

public final int getColour(int biome,
                           ColourScheme colourScheme)

Description copied from interface: BiomeScheme

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

public final 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.

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.

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.

Parameters:

biome - The biome ID to check.

Returns:

true if this biome scheme contains the specified biome.

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.

Parameters:

biome - The biome for which to retrieve the name.

Returns:

The name of the specified biome.