Package org.geysermc.geyser.api.extension

Interface ExtensionDescription

public interface ExtensionDescription
Represents the description of an Extension.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    apiVersion()
    Returns the extension's requested Geyser Api version.
    @NonNull List<String>
    authors()
    Gets the extension's authors.
    int
    humanApiVersion()
    Represents the human api version that the extension requires.
    @NonNull String
    id()
    Gets the extension's id.
    @NonNull String
    main()
    Gets the extension's main class.
    int
    majorApiVersion()
    Represents the major api version that the extension requires.
    int
    minorApiVersion()
    Represents the minor api version that the extension requires.
    @NonNull String
    name()
    Gets the extension's name.
    default int
    patchApiVersion()
    Deprecated, for removal: This API element is subject to removal in a future version.
    @NonNull String
    version()
    Gets the extension's description.

  • Method Details

    • id

      @NonNull String id()
      Gets the extension's id.
      Returns:
      the extension's id

    • name

      @NonNull String name()
      Gets the extension's name.
      Returns:
      the extension's name

    • main

      @NonNull String main()
      Gets the extension's main class.
      Returns:
      the extension's main class

    • humanApiVersion

      int humanApiVersion()
      Represents the human api version that the extension requires. See the Geyser version outline) for more details on the Geyser API version.
      Returns:
      the extension's requested human api version

    • majorApiVersion

      int majorApiVersion()
      Represents the major api version that the extension requires. See the Geyser version outline) for more details on the Geyser API version.
      Returns:
      the extension's requested major api version

    • minorApiVersion

      int minorApiVersion()
      Represents the minor api version that the extension requires. See the Geyser version outline) for more details on the Geyser API version.
      Returns:
      the extension's requested minor api version

    • patchApiVersion

      @Deprecated(forRemoval=true) default int patchApiVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      No longer in use. Geyser is now using an adaption of the romantic versioning scheme. See here for details.

    • apiVersion

      default String apiVersion()
      Returns the extension's requested Geyser Api version.

    • version

      @NonNull String version()
      Gets the extension's description.
      Returns:
      the extension's description

    • authors

      @NonNull List<String> authors()
      Gets the extension's authors.
      Returns:
      the extension's authors