core/com.github.spigotbasics.core.module/BasicsModule

BasicsModule

interface BasicsModule

Represents a module. Implementations require a public constructor that takes in a com.github.spigotbasics.core.module.loader.ModuleInstantiationContext.

Inheritors

Properties

Link copied to clipboard
abstract val commandFactory: CommandFactory

This module's CommandFactory

Link copied to clipboard
abstract val commandManager: BasicsCommandManager

This module's command manager

Link copied to clipboard
abstract val config: SavedConfig

This module's config

Link copied to clipboard
abstract val coreConfig: CoreConfig

The CoreConfig instance

Link copied to clipboard
abstract val coreMessages: CoreMessages

The CoreMessages instance

Link copied to clipboard
abstract val eventBus: BasicsEventBus

This module's event bus

Link copied to clipboard
abstract val file: File

This module's .jar file

Link copied to clipboard
abstract val info: ModuleInfo

Info about this module

Link copied to clipboard
abstract val keyFactory: NamespacedNamespacedKeyFactory

This module's key factory

Link copied to clipboard
abstract val logger: BasicsLogger

This module's Logger

Link copied to clipboard
abstract val messageFactory: MessageFactory

The global Message Factory

Link copied to clipboard
abstract val messages: SavedConfig

This module's message config

Link copied to clipboard
abstract val moduleClassLoader: ModuleJarClassLoader

This module's class loader

Link copied to clipboard
abstract val permissionManager: BasicsPermissionManager

This module's permission manager

Link copied to clipboard
abstract val plugin: BasicsPlugin

Basics instance

Link copied to clipboard
abstract val scheduler: BasicsScheduler

This module's scheduler

Link copied to clipboard
abstract val server: Server

Bukkit Server instance

Link copied to clipboard
abstract val tagResolverFactory: TagResolverFactory

The global Tag Resolver Factory

Functions

Link copied to clipboard
abstract fun createStorage(name: String? = null): NamespacedStorage
Link copied to clipboard
abstract fun disable(): CompletableFuture<Void?>
Link copied to clipboard
abstract fun enable(reloadConfig: Boolean)
Link copied to clipboard
open fun forgetPlayerData(uuid: UUID)
Link copied to clipboard
abstract fun getConfig(configName: ConfigName): SavedConfig
abstract fun <T : SavedConfig> getConfig(configName: ConfigName, configurationClass: Class<T>): T
Link copied to clipboard
open fun getNamespacedResourceName(path: String): String

Get namespaced resource name in the format -. Also removes leading slashes.

Link copied to clipboard
abstract fun isEnabled(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun onDisable()

Called when the module is disabled

Link copied to clipboard
open fun onEnable()

Called when the module is enabled

Link copied to clipboard
abstract fun reloadConfig()
Link copied to clipboard
Link copied to clipboard