Interface MazeEngineApi

All Known Implementing Classes:
MazeApiProvider
public interface MazeEngineApi
Provides access to the public MazeEngine services.

The enabled plugin registers this interface with Bukkit's ServicesManager. Obtain it with Bukkit.getServicesManager().load(MazeEngineApi.class) after MazeEngine has enabled; Bukkit returns null when no provider is registered.

Typical use cases:

  • Looking up saved mazes and their entrance-to-exit routes
  • Displaying the presets available for new mazes
  • Starting and tracking creation, regeneration, repair, or removal
Registry queries and operations must run on the server thread. Returned snapshots are immutable and may be retained after a query completes.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    VERSION
    The version of the public API contract.

  • Method Summary

    Modifier and Type
    Method
    Description
    MazeRegistry
    mazes()
    Returns the registry used to inspect saved mazes.
    MazeOperations
    operations()
    Returns the service used to submit world-editing operations.
    PresetRegistry
    presets()
    Returns the registry describing the currently configured presets.

  • Field Details

    • VERSION

      static final int VERSION
      The version of the public API contract.

      This value is independent of the plugin release version. It identifies the contract exposed by these interfaces rather than a particular plugin build.

      See Also:

  • Method Details

    • mazes

      MazeRegistry mazes()
      Returns the registry used to inspect saved mazes.

      The registry exposes immutable descriptions, teleport destinations, and routes through the saved cell graph. Its queries require the server thread.

      Returns:
      the maze query service

    • presets

      PresetRegistry presets()
      Returns the registry describing the currently configured presets.

      Successful configuration reloads affect subsequent preset queries. Preset metadata already captured in a saved maze remains unchanged.

      Returns:
      the current preset query service

    • operations

      MazeOperations operations()
      Returns the service used to submit world-editing operations.

      Requests use the plugin's normal permission, ownership, and action-specific safety checks. Each accepted request returns a handle for that operation.

      Returns:
      the maze operation service