Package org.spongepowered.api.map.color

Interface MapColor

All Superinterfaces:

DataSerializable

public interface MapColor
extends DataSerializable

Represents a MapColorType in a given MapShade that may be used when drawing a MapCanvas.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MapColor.Builder	Builds a MapColor

Method Summary

Modifier and Type	Method	Description
static MapColor.Builder	builder()	Creates a MapColor.Builder for generating a new MapColor.
Color	color()	Gets the Color that this MapColor represents.
static MapColor	of(Supplier<MapColorType> mapColorTypeSupplier)	A method to ease using MapColorTypes enumeration.
static MapColor	of(Supplier<MapColorType> mapColorTypeSupplier, Supplier<MapShade> mapShadeSupplier)	A method to ease using the MapColorTypes and MapShade.
static MapColor	of(MapColorType mapColorType)	Creates a MapColor that represents the provided MapColorType with the the default shading.
static MapColor	of(MapColorType mapColorType, MapShade mapShade)	Creates a MapColor that represents the provided MapColorType with the given MapShade.
MapShade	shade()	Gets the MapShade that this MapColor was built from.
MapColorType	type()	Gets the MapColorType that this MapColor was built from.

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Method Details

builder

static MapColor.Builder builder()

Creates a MapColor.Builder for generating a new MapColor.

Returns:

The builder

of

static MapColor of(MapColorType mapColorType)

Creates a MapColor that represents the provided MapColorType with the the default shading.

Parameters:

mapColorType - The MapColorType

Returns:

The MapColor that represents the provided type

of

static MapColor of(Supplier<MapColorType> mapColorTypeSupplier)

A method to ease using MapColorTypes enumeration. Unwraps the given supplier and calls of(MapColorType).

Parameters:

mapColorTypeSupplier - Supplier to unwrap.

Returns:

The MapColor that represents the provided type

of

static MapColor of(MapColorType mapColorType,
 MapShade mapShade)

Creates a MapColor that represents the provided MapColorType with the given MapShade.

Parameters:

mapColorType - The MapColorType

mapShade - The MapShade

Returns:

The MapColor that represents the provided type

of

static MapColor of(Supplier<MapColorType> mapColorTypeSupplier,
 Supplier<MapShade> mapShadeSupplier)

A method to ease using the MapColorTypes and MapShade. Unwraps the given suppliers and calls of(MapColorType, MapShade).

Parameters:

mapColorTypeSupplier - Supplier to unwrap

mapShadeSupplier - Supplier to unwrap

Returns:

The MapColor that represents the provided type.

type

MapColorType type()

Gets the MapColorType that this MapColor was built from.

Returns:

The MapColorType

shade

MapShade shade()

Gets the MapShade that this MapColor was built from.

Returns:

The MapShade

color

Color color()

Gets the Color that this MapColor represents.

Returns:

The Color