Package com.burchard36.api

Class ApiSettings

java.lang.Object
com.burchard36.api.ApiSettings
public class ApiSettings extends Object
The settings for the API to use. do not initialize this, BurchAPI does this already if your main class extends it.
Since:
2.1.5
Author:
Dalton Burchard

  • Field Details

    • dataStoreAutoRegisterBlacklist

      protected final List<Class<? extends DataStore>> dataStoreAutoRegisterBlacklist

  • Constructor Details

    • ApiSettings

      protected ApiSettings()
      Creates a new instance of this class
      Since:
      2.1.5

  • Method Details

    • blockDataStoreFromLoading

      public final ApiSettings blockDataStoreFromLoading​(Class<? extends DataStore> clazz)
      Blocks a DataStore storage handler not load on STARTUP
      Parameters:
      clazz - A class that extends DataStore typically in YourClass.class format
      Returns:
      instance of this class
      Since:
      2.1.8

    • blockCommandFromLoading

      public ApiSettings blockCommandFromLoading​(Class<? extends ApiCommand> clazz)
      Blocks a specific command class from being automatically registered
      Parameters:
      clazz - Class file instance of your class extending ApiCommand
      Returns:
      Instance of this ApiSettings
      Since:
      2.1.5

    • useCommandModule

      public ApiSettings useCommandModule​(boolean useCommandModule)
      Sets whether the Command module should automatically register all of its commands This default value is true
      Parameters:
      useCommandModule - A Boolean, false if you do not want commands to automtically register
      Returns:
      Instance of this ApiSettings
      Since:
      2.1.5

    • useInventoryModule

      public ApiSettings useInventoryModule​(boolean useInventoryModule)
      Sets whether the Listener for the Inventory API should be enabled This value defaults to true
      Parameters:
      useInventoryModule - A Boolean, false if the Listener should not be enabled
      Returns:
      Instance of this ApiSettings
      Since:
      2.1.5