vital-core/dev.vitalframework/VitalPlugin

VitalPlugin

abstract class VitalPlugin(val pluginEnvironment: VitalPlugin.PluginEnvironment)

This class defines internal functionality required to initialize and shutdown a Vital plugin and should rarely be used by developers manually. Plugin bootstrapping is automatically done via the vital-gradle-plugin and initialization is done by vital-loader.

If you for some reason MUST initialize your Vital plugin manually, this would be the class you have to use.

Inheritors

Spigot

Paper

Bungee

Constructors

VitalPlugin

constructor(pluginEnvironment: VitalPlugin.PluginEnvironment)

Types

Bungee

abstract class Bungee : VitalPlugin

Companion

object Companion

Info

@Configuration(proxyBeanMethods = false)

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Info(val name: String, val description: String, val apiVersion: String, val version: String, val author: Array<String>, val scanAdditionalPackages: Array<String> = [])

Defines the info for a Vital-powered plugin. The data defined in this annotation will be used to generate the final plugin jar. A plugin must always have exactly 1 main class that is annotated with this annotation.

Metadata

data class Metadata(val mainClassName: String)

Paper

abstract class Paper : VitalPlugin

PluginEnvironment

enum PluginEnvironment : Enum<VitalPlugin.PluginEnvironment>

Defines all plugin environments supported by Vital.

Spigot

abstract class Spigot : VitalPlugin

Properties

context

lateinit var context: ConfigurableApplicationContext

metadata

lateinit var metadata: VitalPlugin.Metadata

pluginEnvironment

val pluginEnvironment: VitalPlugin.PluginEnvironment

vitalModules

val vitalModules: MutableList<String>

Functions

exit

fun exit()

Shuts down the running Vital framework instance by killing the existing Spring context.

isVitalModuleEnabled

fun isVitalModuleEnabled(vitalModuleName: String): Boolean

Returns if the given vitalModuleName is enabled. Note: Modules are enabled sequentially, during the initialization phase, this function might return false for a module that will be enabled later in the pipeline.

onDisable

open fun onDisable()

Lifecycle function; called when this plugin is disabled.

onEnable

open fun onEnable()

Lifecycle function; called when this plugin is enabled.