Package org.geysermc.geyser.api

Interface GeyserApi

All Superinterfaces:
org.geysermc.api.GeyserApiBase
@NonExtendable public interface GeyserApi extends org.geysermc.api.GeyserApiBase
Represents the API used in Geyser.

  • Method Details

    • connectionByUuid

      @Nullable GeyserConnection connectionByUuid(@NonNull UUID uuid)
      Specified by:
      connectionByUuid in interface org.geysermc.api.GeyserApiBase

    • connectionByXuid

      @Nullable GeyserConnection connectionByXuid(@NonNull String xuid)
      Specified by:
      connectionByXuid in interface org.geysermc.api.GeyserApiBase

    • onlineConnections

      @NonNull List<? extends GeyserConnection> onlineConnections()
      Specified by:
      onlineConnections in interface org.geysermc.api.GeyserApiBase

    • extensionManager

      @NonNull ExtensionManager extensionManager()
      Gets the ExtensionManager.
      Returns:
      the extension manager

    • provider

      <R extends T, T> @NonNull R provider(@NonNull Class<T> apiClass, @Nullable Object... args)
      Provides an implementation for the specified API type.
      Type Parameters:
      R - the implementation type
      T - the API type
      Parameters:
      apiClass - the builder class
      Returns:
      the builder instance
      Throws:
      IllegalArgumentException - if there is no provider for the specified API class

    • eventBus

      @NonNull EventBus<EventRegistrar> eventBus()
      Gets the EventBus for handling Geyser events.
      Returns:
      the event bus

    • defaultRemoteServer

      @NonNull RemoteServer defaultRemoteServer()
      Gets the default RemoteServer configured within the config file that is used by default.
      Returns:
      the default remote server used within Geyser

    • bedrockListener

      @NonNull BedrockListener bedrockListener()
      Gets the BedrockListener used for listening for Minecraft: Bedrock Edition client connections.
      Returns:
      the listener used for Bedrock client connectins

    • configDirectory

      @NonNull Path configDirectory()
      Gets the Path to the Geyser config directory.
      Returns:
      the path to the Geyser config directory

    • packDirectory

      @NonNull Path packDirectory()
      Gets the Path to the Geyser packs directory.
      Returns:
      the path to the Geyser packs directory

    • platformType

      @NonNull PlatformType platformType()
      Gets PlatformType the extension is running on
      Returns:
      type of platform

    • supportedJavaVersion

      @NonNull MinecraftVersion supportedJavaVersion()
      Gets the version of Java Minecraft that is supported.
      Returns:
      the supported version of Java Minecraft

    • supportedBedrockVersions

      @NonNull List<MinecraftVersion> supportedBedrockVersions()
      Gets a list of Bedrock Minecraft versions that are supported.
      Returns:
      the list of supported Bedrock Minecraft versions

    • consoleCommandSource

      @NonNull CommandSource consoleCommandSource()
      Gets the CommandSource for the console.
      Returns:
      the console command source

    • api

      static @NonNull GeyserApi api()
      Gets the current GeyserApiBase instance.
      Returns:
      the current geyser api instance

    • geyserApiVersion

      default org.geysermc.api.util.ApiVersion geyserApiVersion()
      Returns the ApiVersion representing the current Geyser api version. See the Geyser version outline)
      Returns:
      the current geyser api version