Interface BasicsModule
-
- All Implemented Interfaces:
public interface BasicsModule
Represents a module. Implementations require a public constructor that takes in a com.github.spigotbasics.core.module.loader.ModuleInstantiationContext.
-
-
Method Summary
Modifier and Type Method Description Unit
onEnable()
Called when the module is enabled Unit
onDisable()
Called when the module is disabled abstract Unit
reloadConfig()
abstract Unit
enable(Boolean reloadConfig)
abstract CompletableFuture<Void>
disable()
abstract Boolean
isEnabled()
CompletableFuture<Void>
loadPlayerData(UUID uuid)
CompletableFuture<Void>
savePlayerData(UUID uuid)
Unit
forgetPlayerData(UUID uuid)
abstract CompletableFuture<Void>
loadAllOnlinePlayerData()
abstract CompletableFuture<Void>
saveAndForgetAllOnlinePlayerData()
abstract NamespacedStorage
createStorage(String name)
abstract SavedConfig
getConfig(ConfigName configName)
abstract <T extends SavedConfig> T
getConfig(ConfigName configName, Class<T> configurationClass)
String
getNamespacedResourceName(String path)
Get namespaced resource name in the format <module-name>-<path>. abstract BasicsPlugin
getPlugin()
Basics instance abstract CoreConfig
getCoreConfig()
The CoreConfig instance abstract MessageFactory
getMessageFactory()
The global Message Factory abstract CoreMessages
getCoreMessages()
The CoreMessages instance abstract TagResolverFactory
getTagResolverFactory()
The global Tag Resolver Factory abstract Server
getServer()
Bukkit Server instance abstract File
getFile()
This module's . abstract ModuleJarClassLoader
getModuleClassLoader()
This module's class loader abstract ModuleInfo
getInfo()
Info about this module abstract SavedConfig
getConfig()
This module's config abstract SavedConfig
getMessages()
This module's message config abstract BasicsLogger
getLogger()
This module's Logger abstract BasicsScheduler
getScheduler()
This module's scheduler abstract BasicsCommandManager
getCommandManager()
This module's command manager abstract BasicsEventBus
getEventBus()
This module's event bus abstract BasicsPermissionManager
getPermissionManager()
This module's permission manager abstract NamespacedNamespacedKeyFactory
getKeyFactory()
This module's key factory abstract CommandFactory
getCommandFactory()
This module's CommandFactory -
-
Method Detail
-
reloadConfig
abstract Unit reloadConfig()
-
disable
abstract CompletableFuture<Void> disable()
-
loadPlayerData
CompletableFuture<Void> loadPlayerData(UUID uuid)
-
savePlayerData
CompletableFuture<Void> savePlayerData(UUID uuid)
-
forgetPlayerData
Unit forgetPlayerData(UUID uuid)
-
loadAllOnlinePlayerData
abstract CompletableFuture<Void> loadAllOnlinePlayerData()
-
saveAndForgetAllOnlinePlayerData
abstract CompletableFuture<Void> saveAndForgetAllOnlinePlayerData()
-
createStorage
abstract NamespacedStorage createStorage(String name)
-
getConfig
abstract SavedConfig getConfig(ConfigName configName)
-
getConfig
abstract <T extends SavedConfig> T getConfig(ConfigName configName, Class<T> configurationClass)
-
getNamespacedResourceName
String getNamespacedResourceName(String path)
Get namespaced resource name in the format <module-name>-<path>. Also removes leading slashes.
- Parameters:
path
- Path to the resource- Returns:
Namespaced resource name
-
getPlugin
abstract BasicsPlugin getPlugin()
Basics instance
-
getCoreConfig
abstract CoreConfig getCoreConfig()
The CoreConfig instance
-
getMessageFactory
abstract MessageFactory getMessageFactory()
The global Message Factory
-
getCoreMessages
abstract CoreMessages getCoreMessages()
The CoreMessages instance
-
getTagResolverFactory
abstract TagResolverFactory getTagResolverFactory()
The global Tag Resolver Factory
-
getServer
abstract Server getServer()
Bukkit Server instance
-
getModuleClassLoader
abstract ModuleJarClassLoader getModuleClassLoader()
This module's class loader
-
getInfo
abstract ModuleInfo getInfo()
Info about this module
-
getConfig
abstract SavedConfig getConfig()
This module's config
-
getMessages
abstract SavedConfig getMessages()
This module's message config
-
getLogger
abstract BasicsLogger getLogger()
This module's Logger
-
getScheduler
abstract BasicsScheduler getScheduler()
This module's scheduler
-
getCommandManager
abstract BasicsCommandManager getCommandManager()
This module's command manager
-
getEventBus
abstract BasicsEventBus getEventBus()
This module's event bus
-
getPermissionManager
abstract BasicsPermissionManager getPermissionManager()
This module's permission manager
-
getKeyFactory
abstract NamespacedNamespacedKeyFactory getKeyFactory()
This module's key factory
-
getCommandFactory
abstract CommandFactory getCommandFactory()
This module's CommandFactory
-
-
-
-