Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.map.MapView Interface Reference

Classes

enum  Scale
 

Public Member Functions

short getId ()
 
boolean isVirtual ()
 
Scale getScale ()
 
void setScale (Scale scale)
 
int getCenterX ()
 
int getCenterZ ()
 
void setCenterX (int x)
 
void setCenterZ (int z)
 
World getWorld ()
 
void setWorld (World world)
 
List< MapRenderergetRenderers ()
 
void addRenderer (MapRenderer renderer)
 
boolean removeRenderer (MapRenderer renderer)
 

Detailed Description

Represents a map item.

Definition at line 9 of file MapView.java.

Member Function Documentation

void org.bukkit.map.MapView.addRenderer ( MapRenderer  renderer)

Add a renderer to this map.

Parameters
rendererThe MapRenderer to add.
int org.bukkit.map.MapView.getCenterX ( )

Get the center X position of this map.

Returns
The center X position.
int org.bukkit.map.MapView.getCenterZ ( )

Get the center Z position of this map.

Returns
The center Z position.
short org.bukkit.map.MapView.getId ( )

Get the ID of this map item. Corresponds to the damage value of a map in an inventory.

Returns
The ID of the map.
Deprecated:
Magic value
List<MapRenderer> org.bukkit.map.MapView.getRenderers ( )

Get a list of MapRenderers currently in effect.

Returns
A List<MapRenderer> containing each map renderer.
Scale org.bukkit.map.MapView.getScale ( )

Get the scale of this map.

Returns
The scale of the map.
World org.bukkit.map.MapView.getWorld ( )

Get the world that this map is associated with. Primarily used by the internal renderer, but may be used by external renderers. May return null if the world the map is associated with is not loaded.

Returns
The World this map is associated with.
boolean org.bukkit.map.MapView.isVirtual ( )

Check whether this map is virtual. A map is virtual if its lowermost MapRenderer is plugin-provided.

Returns
Whether the map is virtual.
boolean org.bukkit.map.MapView.removeRenderer ( MapRenderer  renderer)

Remove a renderer from this map.

Parameters
rendererThe MapRenderer to remove.
Returns
True if the renderer was successfully removed.
void org.bukkit.map.MapView.setCenterX ( int  x)

Set the center X position of this map.

Parameters
xThe center X position.
void org.bukkit.map.MapView.setCenterZ ( int  z)

Set the center Z position of this map.

Parameters
zThe center Z position.
void org.bukkit.map.MapView.setScale ( Scale  scale)

Set the scale of this map.

Parameters
scaleThe scale to set.
void org.bukkit.map.MapView.setWorld ( World  world)

Set the world that this map is associated with. The world is used by the internal renderer, and may also be used by external renderers.

Parameters
worldThe World to associate this map with.

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