Class AbstractBasicsModule
-
- All Implemented Interfaces:
-
com.github.spigotbasics.core.module.BasicsModule
public abstract class AbstractBasicsModule implements BasicsModule
Represents the main class of a module. Extending classes require a public constructor that takes in a ModuleInstantiationContext.
-
-
Field Summary
Fields Modifier and Type Field Description private final Server
server
private final ModuleJarClassLoader
moduleClassLoader
private final File
file
private final ModuleInfo
info
private final BasicsLogger
logger
private final BasicsPlugin
plugin
private final CoreConfig
coreConfig
private final CoreMessages
coreMessages
private final BasicsEventBus
eventBus
private final SavedConfig
config
private final SavedConfig
messages
private final BasicsScheduler
scheduler
private final BasicsCommandManager
commandManager
private final MessageFactory
messageFactory
private final TagResolverFactory
tagResolverFactory
private final BasicsPermissionManager
permissionManager
private final CommandFactory
commandFactory
private final NamespacedNamespacedKeyFactory
keyFactory
-
Constructor Summary
Constructors Constructor Description AbstractBasicsModule(ModuleInstantiationContext context)
-
Method Summary
Modifier and Type Method Description final Server
getServer()
Bukkit Server instance final ModuleJarClassLoader
getModuleClassLoader()
This module's class loader final File
getFile()
This module's . final ModuleInfo
getInfo()
Info about this module final BasicsLogger
getLogger()
This module's Logger final BasicsPlugin
getPlugin()
Basics instance final CoreConfig
getCoreConfig()
The CoreConfig instance final CoreMessages
getCoreMessages()
The CoreMessages instance final BasicsEventBus
getEventBus()
This module's event bus final SavedConfig
getConfig()
This module's config SavedConfig
getMessages()
This module's message config final BasicsScheduler
getScheduler()
This module's scheduler final BasicsCommandManager
getCommandManager()
This module's command manager final MessageFactory
getMessageFactory()
The global Message Factory final TagResolverFactory
getTagResolverFactory()
The global Tag Resolver Factory final BasicsPermissionManager
getPermissionManager()
This module's permission manager final CommandFactory
getCommandFactory()
This module's CommandFactory final NamespacedNamespacedKeyFactory
getKeyFactory()
This module's key factory Unit
reloadConfig()
final NamespacedStorage
createStorage(String name)
final Unit
enable(Boolean reloadConfig)
final CompletableFuture<Void>
disable()
final Boolean
isEnabled()
final CompletableFuture<Void>
loadAllOnlinePlayerData()
final CompletableFuture<Void>
saveAndForgetAllOnlinePlayerData()
final SavedConfig
getConfig(ConfigName configName)
final <T extends SavedConfig> T
getConfig(ConfigName configName, Class<T> configurationClass)
final RawCommandBuilder
createCommand(String name, Permission permission)
-
Methods inherited from class com.github.spigotbasics.core.module.BasicsModule
forgetPlayerData, getNamespacedResourceName, loadPlayerData, onDisable, onEnable, savePlayerData
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
AbstractBasicsModule
AbstractBasicsModule(ModuleInstantiationContext context)
-
-
Method Detail
-
getServer
final Server getServer()
Bukkit Server instance
-
getModuleClassLoader
final ModuleJarClassLoader getModuleClassLoader()
This module's class loader
-
getInfo
final ModuleInfo getInfo()
Info about this module
-
getLogger
final BasicsLogger getLogger()
This module's Logger
-
getPlugin
final BasicsPlugin getPlugin()
Basics instance
-
getCoreConfig
final CoreConfig getCoreConfig()
The CoreConfig instance
-
getCoreMessages
final CoreMessages getCoreMessages()
The CoreMessages instance
-
getEventBus
final BasicsEventBus getEventBus()
This module's event bus
-
getConfig
final SavedConfig getConfig()
This module's config
-
getMessages
SavedConfig getMessages()
This module's message config
-
getScheduler
final BasicsScheduler getScheduler()
This module's scheduler
-
getCommandManager
final BasicsCommandManager getCommandManager()
This module's command manager
-
getMessageFactory
final MessageFactory getMessageFactory()
The global Message Factory
-
getTagResolverFactory
final TagResolverFactory getTagResolverFactory()
The global Tag Resolver Factory
-
getPermissionManager
final BasicsPermissionManager getPermissionManager()
This module's permission manager
-
getCommandFactory
final CommandFactory getCommandFactory()
This module's CommandFactory
-
getKeyFactory
final NamespacedNamespacedKeyFactory getKeyFactory()
This module's key factory
-
reloadConfig
Unit reloadConfig()
-
createStorage
final NamespacedStorage createStorage(String name)
-
disable
final CompletableFuture<Void> disable()
-
loadAllOnlinePlayerData
final CompletableFuture<Void> loadAllOnlinePlayerData()
-
saveAndForgetAllOnlinePlayerData
final CompletableFuture<Void> saveAndForgetAllOnlinePlayerData()
-
getConfig
final SavedConfig getConfig(ConfigName configName)
-
getConfig
final <T extends SavedConfig> T getConfig(ConfigName configName, Class<T> configurationClass)
-
createCommand
@Deprecated(message = "Use BasicsModule#commandFactory instead", replaceWith = @ReplaceWith(imports = {}, expression = "commandFactory.rawCommandBuilder(name, permission)")) final RawCommandBuilder createCommand(String name, Permission permission)
-
-
-
-