Interface VelocityExtension

All Known Implementing Classes:
VelocityExtensionImpl
public interface VelocityExtension
A velocity plugin description configurable interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    addDependencies(boolean optional, String... ids)
    Adds dependencies to load before this plugin.
    default void
    addDependencies(String... ids)
    Adds dependencies to load before this plugin.
    default void
    addDependency(String id)
    Adds a dependency to load before this plugin.
    default void
    addDependency(String id, boolean optional)
    Adds a dependency to load before this plugin.
    org.gradle.api.provider.SetProperty<String>
    authors()
    The authors of the plugin.
    default void
    authors(String... authors)
    Sets the authors of the plugin.
    org.gradle.api.provider.SetProperty<Dependency>
    dependencies()
    The dependencies required to load before this plugin.
    org.gradle.api.provider.Property<String>
    description()
    The description of the plugin.
    default void
    description(String description)
    Sets the description of the plugin.
    org.gradle.api.provider.Property<String>
    id()
    The id of the plugin.
    default void
    id(String id)
    Sets the id of the plugin.
    org.gradle.api.provider.Property<String>
    main()
    The plugin's initial class file.
    default void
    main(String main)
    Sets the plugin's initial class file.
    org.gradle.api.provider.Property<String>
    name()
    The human-readable name of the plugin as to be used in descriptions and similar things.
    default void
    name(String name)
    Sets the human-readable name of the plugin.
    org.gradle.api.provider.Property<String>
    version()
    The version of the plugin.
    default void
    version(String version)
    Sets the version of the plugin.

  • Method Details

    • main

      @Nonnull org.gradle.api.provider.Property<String> main()
      The plugin's initial class file. This main can't start with minecraft packages or derivative.
      Returns:
      a property providing the plugin's initial class file

    • main

      default void main(@Nonnull String main)
      Sets the plugin's initial class file.
      Parameters:
      main - the plugin's initial class file

    • version

      @Nonnull org.gradle.api.provider.Property<String> version()
      The version of the plugin. If not set, the version will be set to project's version.
      Returns:
      a property providing the version of the plugin

    • version

      default void version(@Nonnull String version)
      Sets the version of the plugin.
      Parameters:
      version - the version of the plugin

    • description

      @Nonnull org.gradle.api.provider.Property<String> description()
      The description of the plugin. If not set, the description will be set to project's description.
      Returns:
      a property providing the description of the plugin

    • description

      default void description(@Nonnull String description)
      Sets the description of the plugin.
      Parameters:
      description - the description of the plugin

    • id

      @Nonnull org.gradle.api.provider.Property<String> id()
      The id of the plugin. This id should be unique as to not conflict with other plugins. The plugin id may contain alphanumeric characters, dashes, and underscores, and be a maximum of 64 characters long.
      Returns:
      a property providing the id for this plugin

    • id

      default void id(@Nonnull String id)
      Sets the id of the plugin.
      Parameters:
      id - the id of the plugin

    • name

      @Nonnull org.gradle.api.provider.Property<String> name()
      The human-readable name of the plugin as to be used in descriptions and similar things.
      Returns:
      a property providing the plugin name

    • name

      default void name(@Nonnull String name)
      Sets the human-readable name of the plugin.
      Parameters:
      name - the human-readable name of the plugin

    • authors

      @Nonnull org.gradle.api.provider.SetProperty<String> authors()
      The authors of the plugin.
      Returns:
      a property providing the author of the plugin

    • authors

      default void authors(@Nonnull String... authors)
      Sets the authors of the plugin.
      Parameters:
      authors - the authors of the plugin

    • dependencies

      @Nonnull org.gradle.api.provider.SetProperty<Dependency> dependencies()
      The dependencies required to load before this plugin.
      Returns:
      a property providing the plugin dependencies

    • addDependency

      default void addDependency(@Nonnull String id)
      Adds a dependency to load before this plugin.

      By default this dependency is not optional, it will be a hard-dependency. If you want to add a soft-dependency, use other addDependency method.

      Parameters:
      id - the plugin id of the dependency

    • addDependency

      default void addDependency(@Nonnull String id, boolean optional)
      Adds a dependency to load before this plugin.
      Parameters:
      id - the plugin id of the dependency
      optional - whether the dependency is not required to enable this plugin

    • addDependencies

      default void addDependencies(@Nonnull String... ids)
      Adds dependencies to load before this plugin.

      By default these dependencies are not optional, it will be hard-dependencies. If you want to add soft-dependencies, use other addDependencies method.

      Parameters:
      ids - the plugin id of the dependencies

    • addDependencies

      default void addDependencies(boolean optional, @Nonnull String... ids)
      Adds dependencies to load before this plugin.
      Parameters:
      optional - whether the dependencies are not required to enable this plugin
      ids - the plugin id of the dependencies