Package net.thenextlvl.worlds.api

Interface WorldsProvider

All Superinterfaces:
org.bukkit.command.CommandExecutor, io.papermc.paper.plugin.lifecycle.event.LifecycleEventOwner, net.kyori.adventure.key.Namespaced, org.bukkit.plugin.Plugin, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor
@NullMarked public interface WorldsProvider extends org.bukkit.plugin.Plugin
The WorldsProvider is the main API interface that enables interaction with world management functionalities such as chunk generation, level handling, and world grouping. It provides access to various tools and services that facilitate operations on Minecraft world data and configurations.
Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    GeneratorView
    generatorView()
    Provides access to the GeneratorView instance, which allows querying and interacting with the generator-related functionality of plugins, such as verifying the presence of chunk generators or biome providers.
    default @Nullable net.thenextlvl.perworlds.GroupProvider
    groupProvider()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Worlds does no longer provide PerWorlds anymore.
    Level.Builder
    levelBuilder(Path level)
    Creates a Level.Builder instance to configure and build a level from the specified directory.
    Level.Builder
    levelBuilder(org.bukkit.World world)
    Creates a Level.Builder instance as a copy of the specified World.
    LevelView
    levelView()
    Provides access to the LevelView functionality, which includes operations for managing Minecraft world levels, such as saving, unloading, and retrieving level data.
    LinkProvider
    linkProvider()
    Retrieves the LinkProvider responsible for managing and retrieving associations between worlds and their respective LinkTree structures.

    Methods inherited from interface org.bukkit.command.CommandExecutor

    onCommand

    Methods inherited from interface net.kyori.adventure.key.Namespaced

    namespace

    Methods inherited from interface org.bukkit.plugin.Plugin

    getComponentLogger, getConfig, getDataFolder, getDataPath, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getLifecycleManager, getLog4JLogger, getLogger, getName, getPluginLoader, getPluginMeta, getResource, getServer, getSLF4JLogger, isEnabled, isNaggable, onDisable, onEnable, onLoad, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable

    Methods inherited from interface org.bukkit.command.TabCompleter

    onTabComplete

  • Method Details

    • generatorView

      @Contract(pure=true) GeneratorView generatorView()
      Provides access to the GeneratorView instance, which allows querying and interacting with the generator-related functionality of plugins, such as verifying the presence of chunk generators or biome providers.
      Returns:
      the GeneratorView instance used for managing and retrieving generator information

    • levelBuilder

      @Contract(value="_ -> new", pure=true) Level.Builder levelBuilder(Path level)
      Creates a Level.Builder instance to configure and build a level from the specified directory. The given level path will be resolved from the world container.
      Parameters:
      level - the path representing the level to be built
      Returns:
      a Level.Builder for configuring and creating the specified level
      Since:
      3.0.0

    • levelBuilder

      @Contract(value="_ -> new", pure=true) Level.Builder levelBuilder(org.bukkit.World world)
      Creates a Level.Builder instance as a copy of the specified World. This method allows configuration and building of a level based on the given world's properties.
      Parameters:
      world - the world to create a builder copy from
      Returns:
      a Level.Builder instance for configuring and modifying the copied level
      Since:
      3.0.0

    • levelView

      @Contract(pure=true) LevelView levelView()
      Provides access to the LevelView functionality, which includes operations for managing Minecraft world levels, such as saving, unloading, and retrieving level data.
      Returns:
      the LevelView instance used to interact with world level operations

    • linkProvider

      @Contract(pure=true) LinkProvider linkProvider()
      Retrieves the LinkProvider responsible for managing and retrieving associations between worlds and their respective LinkTree structures. This provider facilitates the creation, querying, and management of links between worlds and their portal relationships.
      Returns:
      the LinkProvider instance
      Since:
      3.0.0

    • groupProvider

      @Contract(pure=true) @Deprecated(forRemoval=true, since="3.3.0") default @Nullable net.thenextlvl.perworlds.GroupProvider groupProvider()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Worlds does no longer provide PerWorlds anymore.
      Retrieves the GroupProvider instance responsible for managing and interacting with world groups. A group provider facilitates the creation, retrieval, and modification of world groups.
      Returns:
      the GroupProvider instance, or null if unsupported (e.g., in environments like Folia)
      Since:
      2.2.0