Package enterprises.iwakura.modularbot.base

Class Module<TConfig extends ModuleConfig>

java.lang.Object
enterprises.iwakura.modularbot.base.Module<TConfig>
public abstract class Module<TConfig extends ModuleConfig> extends Object

  • Constructor Details

    • Module

      public Module()

  • Method Details

    • onLoad

      public void onLoad()
      This method is called when the module is loaded

    • onEnable

      public abstract void onEnable()
      This method is called when the module is enabling

    • onDisable

      public abstract void onDisable()
      This method is called when the module is disabling

    • onUnload

      public void onUnload()
      This method is called when the module is unloaded

    • onCommandClientBuilderInitialization

      public void onCommandClientBuilderInitialization(@NonNull @NonNull com.jagrosh.jdautilities.command.CommandClientBuilder commandClientBuilder)
      This method is called when the JDA Utilities' CommandClientBuilder is initializing. You cna register commands here and more.
      Parameters:
      commandClientBuilder - Non-null CommandClientBuilder

    • onShardManagerBuilderInitialization

      public void onShardManagerBuilderInitialization(@NonNull @NonNull net.dv8tion.jda.api.sharding.DefaultShardManagerBuilder shardManagerBuilder)
      This method is called when the JDA is initializing. You can register events here and more.
      Parameters:
      shardManagerBuilder - Non-null DefaultShardManagerBuilder

    • onConsoleCommandRegistration

      public void onConsoleCommandRegistration(@NonNull @NonNull enterprises.iwakura.ganyu.Ganyu ganyu)
      This method is called when Modular Bot is registering console commands
      Parameters:
      ganyu - Non-null Ganyu

    • onUncaughtException

      public void onUncaughtException(@NonNull @NonNull Throwable throwable)
      This method is called when some exception is uncaught
      Parameters:
      throwable - Non-null Throwable

    • getIrminsulEntities

      public List<Class<?>> getIrminsulEntities()
      Gets a list of all Irminsul entities (JPA-like entities) used by this module. These will be registered automatically.
      Returns:
      Non-null list of JPA entities

    • setModuleConfig

      public void setModuleConfig(ModuleConfig moduleConfig)
      Sets the module configuration. This is called by Modular Bot itself.
      Parameters:
      moduleConfig - Non-null ModuleConfig