Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.map.MapRenderer Class Referenceabstract

Public Member Functions

 MapRenderer ()
 
 MapRenderer (boolean contextual)
 
final boolean isContextual ()
 
void initialize (MapView map)
 
abstract void render (MapView map, MapCanvas canvas, Player player)
 

Detailed Description

Represents a renderer for a map.

Definition at line 8 of file MapRenderer.java.

Constructor & Destructor Documentation

org.bukkit.map.MapRenderer.MapRenderer ( )

Initialize the map renderer base to be non-contextual. See isContextual().

Definition at line 16 of file MapRenderer.java.

16  {
17  this(false);
18  }
org.bukkit.map.MapRenderer.MapRenderer ( boolean  contextual)

Initialize the map renderer base with the given contextual status.

Parameters
contextualWhether the renderer is contextual. See isContextual().

Definition at line 26 of file MapRenderer.java.

26  {
27  this.contextual = contextual;
28  }

Member Function Documentation

void org.bukkit.map.MapRenderer.initialize ( MapView  map)

Initialize this MapRenderer for the given map.

Parameters
mapThe MapView being initialized.

Definition at line 45 of file MapRenderer.java.

45 {}
final boolean org.bukkit.map.MapRenderer.isContextual ( )

Get whether the renderer is contextual, i.e. has different canvases for different players.

Returns
True if contextual, false otherwise.

Definition at line 36 of file MapRenderer.java.

36  {
37  return contextual;
38  }
abstract void org.bukkit.map.MapRenderer.render ( MapView  map,
MapCanvas  canvas,
Player  player 
)
abstract

Render to the given map.

Parameters
mapThe MapView being rendered to.
canvasThe canvas to use for rendering.
playerThe player who triggered the rendering.

The documentation for this class was generated from the following file: