org.pepsoft.worldpainter.biomeschemes

Class AbstractMinecraft1_7BiomeScheme

java.lang.Object

org.pepsoft.worldpainter.biomeschemes.AbstractBiomeScheme

org.pepsoft.worldpainter.biomeschemes.AbstractMinecraft1_7BiomeScheme

All Implemented Interfaces:

BiomeScheme, Minecraft1_7Biomes

Direct Known Subclasses:

Minecraft1_12BiomeInfo, Minecraft1_12JarBiomeScheme, Minecraft1_7JarBiomeScheme, Minecraft1_8JarBiomeScheme

public abstract class AbstractMinecraft1_7BiomeScheme
extends AbstractBiomeScheme
implements Minecraft1_7Biomes

An abstract base class for BiomeSchemes which provide the biomes as used in Minecraft 1.7 to 1.12.1.

Nested Class Summary

Nested classes/interfaces inherited from interface org.pepsoft.worldpainter.biomeschemes.Minecraft1_7Biomes

Minecraft1_7Biomes.StaticInitialiser

Field Summary

Fields inherited from interface org.pepsoft.worldpainter.biomeschemes.Minecraft1_7Biomes

BIOME_BEACH, BIOME_BIRCH_FOREST, BIOME_BIRCH_FOREST_HILLS, BIOME_BIRCH_FOREST_HILLS_M, BIOME_BIRCH_FOREST_M, BIOME_COLD_BEACH, BIOME_COLD_TAIGA, BIOME_COLD_TAIGA_HILLS, BIOME_COLD_TAIGA_M, BIOME_DEEP_OCEAN, BIOME_DESERT, BIOME_DESERT_HILLS, BIOME_DESERT_M, BIOME_EXTREME_HILLS, BIOME_EXTREME_HILLS_EDGE, BIOME_EXTREME_HILLS_M, BIOME_EXTREME_HILLS_PLUS, BIOME_EXTREME_HILLS_PLUS_M, BIOME_FLOWER_FOREST, BIOME_FOREST, BIOME_FOREST_HILLS, BIOME_FROZEN_OCEAN, BIOME_FROZEN_RIVER, BIOME_HELL, BIOME_ICE_MOUNTAINS, BIOME_ICE_PLAINS, BIOME_ICE_PLAINS_SPIKES, BIOME_JUNGLE, BIOME_JUNGLE_EDGE, BIOME_JUNGLE_EDGE_M, BIOME_JUNGLE_HILLS, BIOME_JUNGLE_M, BIOME_MEGA_SPRUCE_TAIGA, BIOME_MEGA_SPRUCE_TAIGA_HILLS, BIOME_MEGA_TAIGA, BIOME_MEGA_TAIGA_HILLS, BIOME_MESA, BIOME_MESA_BRYCE, BIOME_MESA_PLATEAU, BIOME_MESA_PLATEAU_F, BIOME_MESA_PLATEAU_F_M, BIOME_MESA_PLATEAU_M, BIOME_MUSHROOM_ISLAND, BIOME_MUSHROOM_ISLAND_SHORE, BIOME_NAMES, BIOME_OCEAN, BIOME_PATTERNS, BIOME_PLAINS, BIOME_RIVER, BIOME_ROOFED_FOREST, BIOME_ROOFED_FOREST_M, BIOME_SAVANNA, BIOME_SAVANNA_M, BIOME_SAVANNA_PLATEAU, BIOME_SAVANNA_PLATEAU_M, BIOME_SKY, BIOME_STONE_BEACH, BIOME_SUNFLOWER_PLAINS, BIOME_SWAMPLAND, BIOME_SWAMPLAND_M, BIOME_TAIGA, BIOME_TAIGA_HILLS, BIOME_TAIGA_M, FIRST_UNALLOCATED_ID, HIGHEST_BIOME_ID

Constructor Summary

Constructors

Constructor and Description
AbstractMinecraft1_7BiomeScheme()

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

Constructor Detail

AbstractMinecraft1_7BiomeScheme

public AbstractMinecraft1_7BiomeScheme()

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.

Specified by:

getBiomeCount in interface BiomeScheme

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.

Specified by:

getColour in interface BiomeScheme

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.

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.

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.

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.