Package org.bukkit.map
Class MapRenderer
java.lang.Object
org.bukkit.map.MapRenderer
public abstract class MapRenderer extends Object
Represents a renderer for a map.
-
Constructor Summary
Constructors Constructor Description MapRenderer()
Initialize the map renderer base to be non-contextual.MapRenderer(boolean contextual)
Initialize the map renderer base with the given contextual status. -
Method Summary
Modifier and Type Method Description void
initialize(MapView map)
Initialize this MapRenderer for the given map.boolean
isContextual()
Get whether the renderer is contextual, i.e.abstract void
render(MapView map, MapCanvas canvas, Player player)
Render to the given map.
-
Constructor Details
-
MapRenderer
public MapRenderer()Initialize the map renderer base to be non-contextual. SeeisContextual()
. -
MapRenderer
public MapRenderer(boolean contextual)Initialize the map renderer base with the given contextual status.- Parameters:
contextual
- Whether the renderer is contextual. SeeisContextual()
.
-
-
Method Details
-
isContextual
public final boolean isContextual()Get whether the renderer is contextual, i.e. has different canvases for different players.- Returns:
- True if contextual, false otherwise.
-
initialize
Initialize this MapRenderer for the given map.- Parameters:
map
- The MapView being initialized.
-
render
public abstract void render(@NotNull MapView map, @NotNull MapCanvas canvas, @NotNull Player player)Render to the given map.- Parameters:
map
- The MapView being rendered to.canvas
- The canvas to use for rendering.player
- The player who triggered the rendering.
-