org.pepsoft.worldpainter.colourschemes

Class DynMapColourScheme

java.lang.Object

org.pepsoft.worldpainter.colourschemes.DynMapColourScheme

All Implemented Interfaces:

ColourScheme

Deprecated.

Use HardcodedColourScheme. Left here just in case we need it to complete that new implementation

@Deprecated
public final class DynMapColourScheme
extends Object
implements ColourScheme

An implementation of ColourScheme which can read Dynmap "classic" colour scheme files, such as those included with Dynmap.

Field Summary

Fields inherited from interface org.pepsoft.worldpainter.ColourScheme

DEFAULT

Constructor Summary

Constructors

Constructor and Description
DynMapColourScheme(InputStream in, boolean bright) Deprecated. Create a new Dynmap colour scheme, reading the Dynamp "classic" colour scheme-formatted colour map from an input stream.
DynMapColourScheme(@NonNls String name, boolean bright) Deprecated. Create a new Dynmap colour scheme, reading the Dynamp "classic" colour scheme-formatted colour map from a file on the classpath.

Method Summary

Modifier and Type	Method and Description
int	getColour(int blockType) Deprecated. Get the colour of a particular Minecraft block type.
int	getColour(int blockType, int dataValue) Deprecated. Get the colour of a particular Minecraft block type with a particular data value.
int	getColour(Material material) Deprecated. Get the colour of a particular Minecraft material.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynMapColourScheme

public DynMapColourScheme(InputStream in,
                          boolean bright)

Deprecated.

Create a new Dynmap colour scheme, reading the Dynamp "classic" colour scheme-formatted colour map from an input stream.

Parameters:

in - The input stream from which to read the colours.

bright - Whether to use the brightest colours. When false the two block side colours are averaged and used instead. The brightest colours usually most approximate the colours as experienced in Minecraft, so when in doubt, use true.

DynMapColourScheme

public DynMapColourScheme(@NonNls
                          @NonNls String name,
                          boolean bright)

Deprecated.

Create a new Dynmap colour scheme, reading the Dynamp "classic" colour scheme-formatted colour map from a file on the classpath. The file should be named <em>name</em>.txt and be in the org.pepsoft.worldpainter.colourschemes package.

Parameters:

name - The name of the Dynmap "classic" colour map file to read from the classpath, without .txt extension.

bright - Whether to use the brightest colours. When false the two block side colours are averaged and used instead. The brightest colours usually most approximate the colours as experienced in Minecraft, so when in doubt, use true.

Method Detail

getColour

public int getColour(int blockType)

Deprecated.

Description copied from interface: ColourScheme

Get the colour of a particular Minecraft block type.

Specified by:

getColour in interface ColourScheme

Parameters:

blockType - The block type ID for which to get the colour.

Returns:

The colour of the specified block type in packed RGB format.

getColour

public int getColour(int blockType,
                     int dataValue)

Deprecated.

Description copied from interface: ColourScheme

Get the colour of a particular Minecraft block type with a particular data value.

Specified by:

getColour in interface ColourScheme

Parameters:

blockType - The block type ID for which to get the colour.

dataValue - The data value for which to get the colour.

Returns:

The colour of the specified block type in packed RGB format.

getColour

public int getColour(Material material)

Deprecated.

Description copied from interface: ColourScheme

Get the colour of a particular Minecraft material.

Specified by:

getColour in interface ColourScheme

Parameters:

material - The material for which to get the colour.

Returns:

The colour of the specified material in packed RGB format.