Package com.plotsquared.core.util

Interface PlatformWorldManager<T>

public interface PlatformWorldManager<T>
This class should be implemented by each platform to allow PlotSquared to interact with the world management solution used on the server.

Special support for world management plugins such as Multiverse and Hyperverse can be added by extending the platform specific class. This way PlotSquared can hook into different APIs and provide better support for that particular plugin

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Get the implementation name
    Collection<String>
    getWorlds()
    Get the names of all worlds on the server
    @Nullable T
    handleWorldCreation​(@NonNull String worldName, @Nullable String generator)
    Inform the manager that PlotSquared has created a new world, using a specified generator.
    void
    initialize()
    Initialize the platform world manager

  • Method Details

    • initialize

      void initialize()
      Initialize the platform world manager

    • handleWorldCreation

      @Nullable T handleWorldCreation​(@NonNull String worldName, @Nullable String generator)
      Inform the manager that PlotSquared has created a new world, using a specified generator.
      Parameters:
      worldName - World name
      generator - World generator
      Returns:
      Created world

    • getName

      String getName()
      Get the implementation name
      Returns:
      implementation name

    • getWorlds

      Collection<String> getWorlds()
      Get the names of all worlds on the server
      Returns:
      Worlds