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.
    List<String>
    authors()
    Gets the extension's authors.
    int
    humanApiVersion()
    Represents the human api version that the extension requires.
    String
    id()
    Gets the extension's id.
    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.
    String
    name()
    Gets the extension's name.
    default int
    patchApiVersion()
    Deprecated, for removal: This API element is subject to removal in a future version.
    String
    version()
    Gets the extension's description.

  • Method Details

    • id

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

    • name

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

    • main

      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

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

    • authors

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