Package com.xyrisdev.cloud.api

Interface CloudDuelsAPI

All Known Implementing Classes:
CloudDuelsAPIImpl
public interface CloudDuelsAPI

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull ArenaAPI
    arena()
    Gets the Arena API for managing arenas.
    @NotNull ArenaLoaderAPI
    arenaLoader()
    Gets the Arena Loader API for loading and saving arenas.
    @NotNull DuelAPI
    duel()
    Gets the Duel API for managing duel matches.
    @NotNull EventManagerAPI
    eventManager()
    Gets the Event Manager API for registering/triggering cloud events.
    static @NotNull Optional<CloudDuelsAPI>
    getInstance()
    Retrieves an instance of the main API, if registered.
    static @NotNull Optional<? extends org.bukkit.plugin.Plugin>
    getProvidingPlugin()
    Retrieves the plugin instance that provides this API.
    @NotNull KitAPI
    kit()
    Gets the Kit API for managing kits.
    @NotNull LobbyAPI
    lobby()
    Gets the Lobby API for managing lobby spawns.
    @NotNull QueueAPI
    queue()
    Gets the Queue API for managing queues.
    @NotNull RequestAPI
    request()
    Gets the Request API for managing duel requests.
    @NotNull StatsAPI
    stats()
    Gets the Stats API for managing player stats.

  • Method Details

    • getInstance

      @NotNull static @NotNull Optional<CloudDuelsAPI> getInstance()
      Retrieves an instance of the main API, if registered.

      If the API is not registered, an empty Optional is returned.

      Returns:
      An Optional containing the API instance or empty if not found.

    • getProvidingPlugin

      @NotNull static @NotNull Optional<? extends org.bukkit.plugin.Plugin> getProvidingPlugin()
      Retrieves the plugin instance that provides this API.

      If the API is not registered, an empty Optional is returned.

      Returns:
      An Optional containing the plugin instance or empty if not found.

    • arena

      @NotNull @NotNull ArenaAPI arena()
      Gets the Arena API for managing arenas.
      Returns:
      The Arena API instance.

    • arenaLoader

      @NotNull @NotNull ArenaLoaderAPI arenaLoader()
      Gets the Arena Loader API for loading and saving arenas.
      Returns:
      The Arena Loader API instance.

    • kit

      @NotNull @NotNull KitAPI kit()
      Gets the Kit API for managing kits.
      Returns:
      The Kit API instance.

    • lobby

      @NotNull @NotNull LobbyAPI lobby()
      Gets the Lobby API for managing lobby spawns.
      Returns:
      The Lobby API instance.

    • duel

      @NotNull @NotNull DuelAPI duel()
      Gets the Duel API for managing duel matches.
      Returns:
      The Duel API instance.

    • queue

      @NotNull @NotNull QueueAPI queue()
      Gets the Queue API for managing queues.
      Returns:
      The Queue API instance.

    • request

      @NotNull @NotNull RequestAPI request()
      Gets the Request API for managing duel requests.
      Returns:
      The Request API instance.

    • eventManager

      @NotNull @NotNull EventManagerAPI eventManager()
      Gets the Event Manager API for registering/triggering cloud events.
      Returns:
      The Event Manager API instance.

    • stats

      @NotNull @NotNull StatsAPI stats()
      Gets the Stats API for managing player stats.
      Returns:
      The Stats API instance.