MapCanvas (Spigot-API 1.8.8-R0.1-SNAPSHOT API)

```
public interface MapCanvas
```
Represents a canvas for drawing to a map. Each canvas is associated with a specific MapRenderer and represents that renderer's layer on the map.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`drawImage(int x, int y, Image image)` Draw an image to the map.
`void`	`drawText(int x, int y, MapFont font, String text)` Render text to the map using fancy formatting.
`byte`	`getBasePixel(int x, int y)` Get a pixel from the layers below this canvas.
`MapCursorCollection`	`getCursors()` Get the cursor collection associated with this canvas.
`MapView`	`getMapView()` Get the map this canvas is attached to.
`byte`	`getPixel(int x, int y)` Get a pixel from the canvas.
`void`	`setCursors(MapCursorCollection cursors)` Set the cursor collection associated with this canvas.
`void`	`setPixel(int x, int y, byte color)` Draw a pixel to the canvas.

- Method Detail
  - getMapView
```
MapView getMapView()
```
    Get the map this canvas is attached to.
    
    Returns:
    The MapView this canvas is attached to.
  - getCursors
```
MapCursorCollection getCursors()
```
    Get the cursor collection associated with this canvas.
    
    Returns:
    The MapCursorCollection associated with this canvas.
  - setCursors
```
void setCursors(MapCursorCollection cursors)
```
    Set the cursor collection associated with this canvas. This does not usually need to be called since a MapCursorCollection is already provided.
    
    Parameters:
    cursors - The MapCursorCollection to associate with this canvas.
  - setPixel
```
void setPixel(int x,
            int y,
            byte color)
```
    Draw a pixel to the canvas.
    
    Parameters:
    x - The x coordinate, from 0 to 127.
    y - The y coordinate, from 0 to 127.
    color - The color. See MapPalette.
  - getPixel
```
byte getPixel(int x,
            int y)
```
    Get a pixel from the canvas.
    
    Parameters:
    x - The x coordinate, from 0 to 127.
    y - The y coordinate, from 0 to 127.
    
    Returns:
    The color. See MapPalette.
  - getBasePixel
```
byte getBasePixel(int x,
                int y)
```
    Get a pixel from the layers below this canvas.
    
    Parameters:
    x - The x coordinate, from 0 to 127.
    y - The y coordinate, from 0 to 127.
    
    Returns:
    The color. See MapPalette.
  - drawImage
```
void drawImage(int x,
             int y,
             Image image)
```
    Draw an image to the map. The image will be clipped if necessary.
    
    Parameters:
    x - The x coordinate of the image.
    y - The y coordinate of the image.
    image - The Image to draw.
  - drawText
```
void drawText(int x,
            int y,
            MapFont font,
            String text)
```
    Render text to the map using fancy formatting. Newline (\n) characters will move down one line and return to the original column, and the text color can be changed using sequences such as "§12;", replacing 12 with the palette index of the color (see MapPalette).
    
    Parameters:
    x - The column to start rendering on.
    y - The row to start rendering on.
    font - The font to use.
    text - The formatted text to render.

Interface MapCanvas

Method Summary

Method Detail

getMapView

getCursors

setCursors

setPixel

getPixel

getBasePixel

drawImage

drawText