Package xyz.srnyx.annoyingapi.options

Class PluginOptions

java.lang.Object
xyz.srnyx.javautilities.parents.Stringable
xyz.srnyx.annoyingapi.options.PluginOptions
public class PluginOptions extends xyz.srnyx.javautilities.parents.Stringable
Represents the general options for the plugin

  • Field Details

    • isMock

      public boolean isMock
      Whether this plugin is a MOCK plugin for unit tests

    • sendStartupMessages

      public boolean sendStartupMessages
      Whether to send startup messages to the console

    • doUpdateCheck

      public boolean doUpdateCheck
      Whether to check for updates when the plugin is enabled

    • libraries

      @NotNull public @NotNull List<AnnoyingLibrary> libraries
      OPTIONAL The AnnoyingLibraries to load before initializing the plugin
      This is only needed if you have a library that is required to load before the plugin initializes, otherwise you can just load the library yourself when the plugin enables
      Loading these libraries will be one of the first (if not the first) things the plugin does

    • dependencies

      @NotNull public @NotNull List<AnnoyingDependency> dependencies
      OPTIONAL The AnnoyingDependencies to check for (add dependencies to this in the plugin's constructor)

      If you add a dependency to this OUTSIDE the constructor, it will not be checked

      This is NOT meant for optional dependencies, all of these dependencies will be downloaded/installed (even if AnnoyingDependency.required is false)

    • updatePlatforms

      @NotNull public PluginPlatform.Multi updatePlatforms
      RECOMMENDED The different platforms the plugin is available on

      If not specified, the plugin will not be able to check for updates

  • Constructor Details

    • PluginOptions

      public PluginOptions()
      Constructs a new PluginOptions instance with default values

  • Method Details