Interface SlimePlugin

Method Details

• loadWorld

  SlimeWorld loadWorld(SlimeLoader loader, String worldName, boolean readOnly, SlimePropertyMap propertyMap) throws UnknownWorldException, IOException, CorruptedWorldException, NewerFormatException, WorldLockedException

  Loads a world using a specificied SlimeLoader. This world can then be added to the server's world list by using the loadWorld(SlimeWorld) method.

  Parameters:

  loader - SlimeLoader used to retrieve the world.

  worldName - Name of the world.

  readOnly - Whether or not read-only mode is enabled.

  propertyMap - A SlimePropertyMap object containing all the properties of the world.

  Returns:

  A SlimeWorld, which is the in-memory representation of the world.

  Throws:

  UnknownWorldException - if the world cannot be found.

  IOException - if the world cannot be obtained from the speficied data source.

  CorruptedWorldException - if the world retrieved cannot be parsed into a SlimeWorld object.

  NewerFormatException - if the world uses a newer version of the SRF.

  WorldLockedException - if the world is already being used on another server when trying to open it without read-only mode enabled.

• getWorld

  SlimeWorld getWorld(String worldName)

  Gets a world which has already been loaded by ASWM.

  Parameters:

  worldName - the name of the world to get

  Returns:

  the loaded world, or null if no loaded world matches the given name

• getLoadedWorlds

  List<SlimeWorld> getLoadedWorlds()

  Gets a list of worlds which have been loaded by ASWM. Note: The returned list is immutable, and encompasses a view of the loaded worlds at the time of the method call.

  Returns:

  a list of worlds

• createEmptyWorld

  SlimeWorld createEmptyWorld(SlimeLoader loader, String worldName, boolean readOnly, SlimePropertyMap propertyMap) throws WorldAlreadyExistsException, IOException

  Creates an empty world and stores it using a specified SlimeLoader. This world can then be added to the server's world list by using the loadWorld(SlimeWorld) method.

  Parameters:

  loader - SlimeLoader used to store the world.

  worldName - Name of the world.

  readOnly - Whether or not read-only mode is enabled.

  propertyMap - A SlimePropertyMap object containing all the properties of the world.

  Returns:

  A SlimeWorld, which is the in-memory representation of the world.

  Throws:

  WorldAlreadyExistsException - if the provided data source already contains a world with the same name.

  IOException - if the world could not be stored.

• loadWorld

  default SlimeWorld loadWorld(SlimeWorld world) throws UnknownWorldException, WorldLockedException, IOException

  Generates a Minecraft World from a SlimeWorld and adds it to the server's world list.

  Parameters:

  world - SlimeWorld world to be added to the server's world list

  Returns:

  Returns a slime world representing a live minecraft world

  Throws:

  UnknownWorldException

  WorldLockedException

  IOException

• loadWorld

  SlimeWorld loadWorld(SlimeWorld world, boolean callWorldLoadEvent) throws UnknownWorldException, WorldLockedException, IOException

  Generates a Minecraft World from a SlimeWorld and adds it to the server's world list.

  Parameters:

  world - SlimeWorld world to be added to the server's world list

  callWorldLoadEvent - Whether or not to call WorldLoadEvent

  Returns:

  Returns a slime world representing a live minecraft world

  Throws:

  UnknownWorldException

  WorldLockedException

  IOException

• migrateWorld

  void migrateWorld(String worldName, SlimeLoader currentLoader, SlimeLoader newLoader) throws IOException, WorldAlreadyExistsException, UnknownWorldException

  Migrates a SlimeWorld to another datasource.

  Parameters:

  worldName - The name of the world to be migrated.

  currentLoader - The SlimeLoader of the data source where the world is currently stored in.

  newLoader - The SlimeLoader of the data source where the world will be moved to.

  Throws:

  IOException - if the world could not be migrated.

  WorldAlreadyExistsException - if a world with the same name already exists inside the new data source.

  UnknownWorldException - if the world has been removed from the old data source.

• getLoader

  SlimeLoader getLoader(String dataSource)

  Returns the SlimeLoader that is able to read and store worlds from a specified data source.

  Parameters:

  dataSource - String containing the data source.

  Returns:

  The SlimeLoader capable of reading and writing to the data source.

• registerLoader

  void registerLoader(String dataSource, SlimeLoader loader)

  Registers a custom SlimeLoader. This loader can then be used by Slime World Manager to load and store worlds.

  Parameters:

  dataSource - The data source this loader is capable of reading and writing to.

  loader - The SlimeLoader that is going to be registered.

• importWorld

  void importWorld(File worldDir, String worldName, SlimeLoader loader) throws WorldAlreadyExistsException, InvalidWorldException, WorldLoadedException, WorldTooBigException, IOException

  Imports a world into the SRF and saves it in a data source.

  Parameters:

  worldDir - The directory where the world is.

  worldName - The name of the world.

  loader - The SlimeLoader that will be used to store the world.

  Throws:

  WorldAlreadyExistsException - if the data source already contains a world with the same name.

  InvalidWorldException - if the provided directory does not contain a valid world.

  WorldLoadedException - if the world is loaded on the server.

  WorldTooBigException - if the world is too big to be imported into the SRF.

  IOException - if the world could not be read or stored.

• importVanillaWorld

  SlimeWorld importVanillaWorld(File worldDir, String worldName, SlimeLoader loader) throws WorldAlreadyExistsException, InvalidWorldException, WorldLoadedException, WorldTooBigException, IOException

  Imports a world into the SRF and saves it in a data source.

  Parameters:

  worldDir - The directory where the world is.

  worldName - The name of the world.

  loader - The SlimeLoader that will be used to store the world.

  Returns:

  SlimeWorld to import

  Throws:

  WorldAlreadyExistsException - if the data source already contains a world with the same name.

  InvalidWorldException - if the provided directory does not contain a valid world.

  WorldLoadedException - if the world is loaded on the server.

  WorldTooBigException - if the world is too big to be imported into the SRF.

  IOException - if the world could not be read or stored.