Package org.spongepowered.api.map

Interface MapCanvas

All Superinterfaces:

DataSerializable

public interface MapCanvas
extends DataSerializable

A MapCanvas represents the image that is drawn on a ItemTypes.FILLED_MAP.

A canvas in vanilla Minecraft is 128x128 pixels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MapCanvas.Builder	A builder that creates a MapCanvas.

Method Summary

Modifier and Type	Method	Description
static MapCanvas	blank()	Creates a MapCanvas where all pixels are set to MapColorTypes.NONE.
static MapCanvas.Builder	builder()	Creates a builder for creating a new MapCanvas.
MapColor	color(int x, int y)	Gets the MapColor at the given location.
MapCanvas.Builder	toBuilder()	Creates a MapCanvas.Builder populated with the state of this MapCanvas.
Image	toImage()	Generates an Image from this MapCanvas.
Image	toImage(Color color)	Generates an Image from this MapCanvas, where any pixels that represent MapColorTypes.NONE will be replaced with the supplied Color.

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

contentVersion, toContainer

Method Details

builder

static MapCanvas.Builder builder()

Creates a builder for creating a new MapCanvas.

Returns:

A MapCanvas.Builder to generate a new canvas.

blank

static MapCanvas blank()

Creates a MapCanvas where all pixels are set to MapColorTypes.NONE.

Returns:

A blank canvas

color

MapColor color(int x,
 int y)
        throws IllegalArgumentException

Gets the MapColor at the given location.

Parameters:

x - The x location

y - The y location

Returns:

The MapColor at the location

Throws:

IllegalArgumentException - if either of the requested co-ordinates are out of bounds.

toImage

Image toImage()

Generates an Image from this MapCanvas.

Returns:

An Image

toImage

Image toImage(Color color)

Generates an Image from this MapCanvas, where any pixels that represent MapColorTypes.NONE will be replaced with the supplied Color.

Parameters:

color - the Color used in place of MapColorTypes.NONE

Returns:

An Image

toBuilder

MapCanvas.Builder toBuilder()

Creates a MapCanvas.Builder populated with the state of this MapCanvas.

Changes to the returned builder will not affect this canvas.

Returns:

A MapCanvas.Builder