Package dev.despical.mazeengine.api

package dev.despical.mazeengine.api

Public contracts for integrating other Bukkit plugins with MazeEngine.

Depend on the API JAR with compile-only scope and declare MazeEngine as a plugin dependency. Do not shade these classes: integrations and the provider must share the same API class identities for Bukkit service lookup. Obtain MazeEngineApi from Bukkit's ServicesManager after MazeEngine has enabled.

The API groups its responsibilities into:

• MazeRegistry: saved records and cell routes
• PresetRegistry: current preset metadata
• MazeOperations: authorized world operations

Registry queries, submission, progress, and cancellation require the server thread. Immutable snapshots and completion stages may be retained on other threads. Never block the server thread waiting for completion; schedule Bukkit work explicitly when a callback may execute on another thread.

Related Packages

Package	Description
dev.despical.mazeengine	Plugin lifecycle and the shared entry point for MazeEngine.
dev.despical.mazeengine.api.event	Bukkit events reporting the terminal outcome of accepted maze operations.
dev.despical.mazeengine.api.model	Immutable values describing maze identity, coordinates, geometry, and metadata.
dev.despical.mazeengine.api.operation	Handles, progress samples, and results for accepted world-editing operations.
dev.despical.mazeengine.api.request	Immutable request values for submitting maze creation with preset overrides.

Class	Description
MazeEngineApi	Provides access to the public MazeEngine services.
MazeOperations	Submits maze creation, regeneration, repair, and removal requests.
MazeOperations.RemovalMode	Determines what happens to the maze's block volume during removal.
MazeRegistry	Provides read-only access to saved maze records and their cell graphs.
PresetRegistry	Provides the preset metadata used when submitting new maze requests.