Package org.bukkit.map

Interface MapView

public interface MapView
Represents a map item.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static class  MapView.Scale
    An enum representing all possible scales a map can be set to.

  • Method Summary

    Modifier and Type Method Description
    void addRenderer​(MapRenderer renderer)
    Add a renderer to this map.
    int getCenterX()
    Get the center X position of this map.
    int getCenterZ()
    Get the center Z position of this map.
    short getId()
    Deprecated.
    Magic value
    java.util.List<MapRenderer> getRenderers()
    Get a list of MapRenderers currently in effect.
    MapView.Scale getScale()
    Get the scale of this map.
    World getWorld()
    Get the world that this map is associated with.
    boolean isVirtual()
    Check whether this map is virtual.
    boolean removeRenderer​(MapRenderer renderer)
    Remove a renderer from this map.
    void setCenterX​(int x)
    Set the center X position of this map.
    void setCenterZ​(int z)
    Set the center Z position of this map.
    void setScale​(MapView.Scale scale)
    Set the scale of this map.
    void setWorld​(World world)
    Set the world that this map is associated with.

  • Method Details

    • getId

      @Deprecated short getId()
      Deprecated.
      Magic value
      Get the ID of this map item. Corresponds to the damage value of a map in an inventory.
      Returns:
      The ID of the map.

    • isVirtual

      boolean isVirtual()
      Check whether this map is virtual. A map is virtual if its lowermost MapRenderer is plugin-provided.
      Returns:
      Whether the map is virtual.

    • getScale

      MapView.Scale getScale()
      Get the scale of this map.
      Returns:
      The scale of the map.

    • setScale

      void setScale​(MapView.Scale scale)
      Set the scale of this map.
      Parameters:
      scale - The scale to set.

    • getCenterX

      int getCenterX()
      Get the center X position of this map.
      Returns:
      The center X position.

    • getCenterZ

      int getCenterZ()
      Get the center Z position of this map.
      Returns:
      The center Z position.

    • setCenterX

      void setCenterX​(int x)
      Set the center X position of this map.
      Parameters:
      x - The center X position.

    • setCenterZ

      void setCenterZ​(int z)
      Set the center Z position of this map.
      Parameters:
      z - The center Z position.

    • getWorld

      World 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.

    • setWorld

      void 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:
      world - The World to associate this map with.

    • getRenderers

      java.util.List<MapRenderer> getRenderers()
      Get a list of MapRenderers currently in effect.
      Returns:
      A List<MapRenderer> containing each map renderer.

    • addRenderer

      void addRenderer​(MapRenderer renderer)
      Add a renderer to this map.
      Parameters:
      renderer - The MapRenderer to add.

    • removeRenderer

      boolean removeRenderer​(MapRenderer renderer)
      Remove a renderer from this map.
      Parameters:
      renderer - The MapRenderer to remove.
      Returns:
      True if the renderer was successfully removed.