Package de.bluecolored.bluemap.api

Interface BlueMapWorld

public interface BlueMapWorld
This class represents a world loaded by BlueMap.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Getter for the id of this world.
    Collection<BlueMapMap>
    getMaps()
    Getter for all BlueMapMaps for this world
    Path
    getSaveFolder()
    Deprecated.
    Getting the save-folder of a world is no longer supported.

  • Method Details

    • getId

      String getId()
      Getter for the id of this world.
      Returns:
      the id of this world

    • getSaveFolder

      @Deprecated Path getSaveFolder()
      Deprecated.
      Getting the save-folder of a world is no longer supported. As it is not guaranteed that every world has a save-folder.
      Getter for the Path of this world's save-files.
      (To be exact: the parent-folder of the regions-folder used for rendering)
      Returns:
      the save-folder of this world.

    • getMaps

      Collection<BlueMapMap> getMaps()
      Getter for all BlueMapMaps for this world
      Returns:
      an unmodifiable Collection of all BlueMapMaps for this world