Module watamebot
Package net.foxgenesis.watame.plugin

Interface IPlugin

All Superinterfaces:
AutoCloseable
@Deprecated(forRemoval=true) public interface IPlugin extends AutoCloseable
Deprecated, for removal: This API element is subject to removal in a future version.
NEED_JAVADOC
Author:
Ashley

  • Method Summary

    Modifier and Type
    Method
    Description
    default Collection<net.dv8tion.jda.api.interactions.commands.build.CommandData>
    getCommands()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default String
    getDescription()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the description of this plugin.
    default String
    getName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the name of this plugin.
    default Runtime.Version
    getVersion()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the version of this plugin.
    void
    init(ProtectedJDABuilder builder)
    Deprecated, for removal: This API element is subject to removal in a future version.
    NEED_JAVADOC
    void
    onReady(WatameBot bot)
    Deprecated, for removal: This API element is subject to removal in a future version.
    NEED_JAVADOC
    void
    postInit(WatameBot bot)
    Deprecated, for removal: This API element is subject to removal in a future version.
    NEED_JAVADOC
    void
    preInit()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Startup method called when resources, needed for functionality initialization, are to be loaded.
    default boolean
    providesCommands()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether this plugin provides commands/interactions.
    default boolean
    requiresDatabaseConnection()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether this plugin requires access to the database connection.

    Methods inherited from interface java.lang.AutoCloseable

    close

  • Method Details

    • preInit

      void preInit() throws SeverePluginException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Startup method called when resources, needed for functionality initialization, are to be loaded. Resources that do not require connection to Discord or the database should be loaded here.

      Database and Discord information might not be loaded at the time of this method! Use onReady(WatameBot) for functionality that requires valid connections.

      Typical resources to load here include:

      • SQL compiled statements
      • System Data
      • Files
      • Images
      Throws:
      SeverePluginException
      See Also:

    • init

      void init(ProtectedJDABuilder builder) throws SeverePluginException
      Deprecated, for removal: This API element is subject to removal in a future version.
      NEED_JAVADOC
      Throws:
      SeverePluginException
      See Also:

    • postInit

      void postInit(WatameBot bot) throws SeverePluginException
      Deprecated, for removal: This API element is subject to removal in a future version.
      NEED_JAVADOC
      Parameters:
      bot -
      Throws:
      SeverePluginException
      See Also:

    • onReady

      void onReady(WatameBot bot) throws SeverePluginException
      Deprecated, for removal: This API element is subject to removal in a future version.
      NEED_JAVADOC
      Parameters:
      bot -
      Throws:
      SeverePluginException

    • getCommands

      default Collection<net.dv8tion.jda.api.interactions.commands.build.CommandData> getCommands()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getName

      default String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the name of this plugin.
      Returns:
      A string containing the name of the plugin
      See Also:

    • getDescription

      default String getDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the description of this plugin.
      Returns:
      A string containing the description of this plugin
      See Also:

    • getVersion

      default Runtime.Version getVersion()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the version of this plugin.
      Returns:
      A Runtime.Version representing this plugin
      See Also:

    • providesCommands

      default boolean providesCommands()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether this plugin provides commands/interactions.
      Returns:
      If this plugin provides command data

    • requiresDatabaseConnection

      default boolean requiresDatabaseConnection()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether this plugin requires access to the database connection.
      Returns:
      If this plugin uses the database