core/com.github.spigotbasics.core.module/AbstractBasicsModule

AbstractBasicsModule

abstract class AbstractBasicsModule(context: ModuleInstantiationContext) : BasicsModule

Represents the main class of a module. Extending classes require a public constructor that takes in a ModuleInstantiationContext.

Constructors

constructor(context: ModuleInstantiationContext)

Types

Companion

object Companion

Properties

commandFactory

override val commandFactory: CommandFactory

This module's CommandFactory

commandManager

override val commandManager: BasicsCommandManager

This module's command manager

config

override val config: SavedConfig

This module's config

coreConfig

override val coreConfig: CoreConfig

The CoreConfig instance

coreMessages

override val coreMessages: CoreMessages

The CoreMessages instance

eventBus

override val eventBus: BasicsEventBus

This module's event bus

file

override val file: File

This module's .jar file

info

override val info: ModuleInfo

Info about this module

keyFactory

override val keyFactory: NamespacedNamespacedKeyFactory

This module's key factory

logger

override val logger: BasicsLogger

This module's Logger

messageFactory

override val messageFactory: MessageFactory

The global Message Factory

messages

open override val messages: SavedConfig

This module's message config

moduleClassLoader

override val moduleClassLoader: ModuleJarClassLoader

This module's class loader

permissionManager

override val permissionManager: BasicsPermissionManager

This module's permission manager

plugin

override val plugin: BasicsPlugin

Basics instance

scheduler

override val scheduler: BasicsScheduler

This module's scheduler

server

override val server: Server

Bukkit Server instance

tagResolverFactory

override val tagResolverFactory: TagResolverFactory

The global Tag Resolver Factory

Functions

createCommand

fun ~~createCommand~~(name: String, permission: Permission): RawCommandBuilder

createStorage

override fun createStorage(name: String?): NamespacedStorage

disable

override fun disable(): CompletableFuture<Void?>

enable

override fun enable(reloadConfig: Boolean)

forgetPlayerData

open fun forgetPlayerData(uuid: UUID)

getConfig

override fun getConfig(configName: ConfigName): SavedConfig

override fun <T : SavedConfig> getConfig(configName: ConfigName, configurationClass: Class<T>): T

getNamespacedResourceName

open fun getNamespacedResourceName(path: String): String

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

isEnabled

override fun isEnabled(): Boolean

loadAllOnlinePlayerData

override fun loadAllOnlinePlayerData(): CompletableFuture<Void?>

loadPlayerData

open fun loadPlayerData(uuid: UUID): CompletableFuture<Void?>

onDisable

open fun onDisable()

Called when the module is disabled

onEnable

open fun onEnable()

Called when the module is enabled

reloadConfig

open override fun reloadConfig()

saveAndForgetAllOnlinePlayerData

override fun saveAndForgetAllOnlinePlayerData(): CompletableFuture<Void?>

savePlayerData

open fun savePlayerData(uuid: UUID): CompletableFuture<Void?>