Package com.velocitypowered.api.plugin

Interface PluginDescription

  • public interface PluginDescription
    Represents metadata for a specific version of a plugin.

    • Field Detail

      • ID_PATTERN

        static final Pattern ID_PATTERN
        The pattern plugin IDs must match. Plugin IDs may only contain alphanumeric characters, dashes or underscores, must start with an alphabetic character and cannot be longer than 64 characters.

    • Method Detail

      • id

        String id()
        Gets the qualified ID of the Plugin within this container.
        Returns:
        the plugin ID
        See Also:
        Plugin.id()

      • name

        default String name()
        Gets the name of the Plugin within this container.
        Returns:
        a String with the plugin name or the plugin ID
        See Also:
        Plugin.name()

      • version

        default String version()
        Gets the version of the Plugin within this container.
        Returns:
        a String with the plugin version, may be null
        See Also:
        Plugin.version()

      • description

        default @Nullable String description()
        Gets the description of the Plugin within this container.
        Returns:
        a String with the plugin description, may be null
        See Also:
        Plugin.description()

      • url

        default @Nullable String url()
        Gets the url or website of the Plugin within this container.
        Returns:
        an String with the plugin url, may be null
        See Also:
        Plugin.url()

      • authors

        default List<String> authors()
        Gets the authors of the Plugin within this container.
        Returns:
        the plugin authors, may be empty
        See Also:
        Plugin.authors()

      • file

        default @Nullable Path file()
        Returns the file path the plugin was loaded from.
        Returns:
        the path the plugin was loaded from or null if unknown