vital-core/dev.vitalframework/VitalPlugin/Info

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.

@VitalPlugin.Info(
  name = "name",
  description = "description",
  apiVersion = "1.21",
  version = "1.0.0",
  author = {"author1", "author2"}
)
public class MyPlugin extends VitalPlugin.Spigot {
}

Types

Companion

object Companion

Properties

apiVersion

val apiVersion: String

author

val author: Array<String>

description

val description: String

name

val name: String

scanAdditionalPackages

val scanAdditionalPackages: Array<String>

This instructs Vital to scan additional packages for Vital functionality. If you have to include an external dependency in your plugin that uses Vital, like Commands, Configs, etc. this will be the place to define those packages.

version

val version: String