Convenience-annotation to mark a specific class as a listener. Should be used in combination of VitalListener. Internally delegates functionality to Component.

RequiresBungee

class RequiresBungee : Condition

Convenience-condition to mark a class to only be loaded as a bean, when running as a BungeeCord plugin. If not running as a BungeeCord plugin, the annotated bean will not be instantiated by Spring.

RequiresSpigot

class RequiresSpigot : Condition

Convenience-condition to mark a class to only be loaded as a bean, when running as a Spigot plugin. If not running as a Spigot plugin, the annotated bean will not be instantiated by Spring.

RequiresVitalCloudNet4Bridge

class RequiresVitalCloudNet4Bridge : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-cloudnet4-bridge module is used. If not running with the vital-cloudnet4-bridge module, the annotated bean will not be instantiated by Spring.

RequiresVitalCloudNet4Driver

class RequiresVitalCloudNet4Driver : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-cloudnet4-driver module is used. If not running with the vital-cloudnet4-driver module, the annotated bean will not be instantiated by Spring.

RequiresVitalCommands

class RequiresVitalCommands : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-commands module is used. If not running with the vital-commands module, the annotated bean will not be instantiated by Spring.

RequiresVitalConfigs

class RequiresVitalConfigs : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-configs module is used. If not running with the vital-configs module, the annotated bean will not be instantiated by Spring.

RequiresVitalHolograms

class RequiresVitalHolograms : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-holograms module is used. If not running with the vital-holograms module, the annotated bean will not be instantiated by Spring.

RequiresVitalInventories

class RequiresVitalInventories : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-inventories modules is used. If not running with the vital-inventories module, the annotated bean will not be instantiated by Spring.

RequiresVitalItems

class RequiresVitalItems : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-items module is used. If not running with the vital-items module, the annotated bean will not be instantiated by Spring.

RequiresVitalLocalization

class RequiresVitalLocalization : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-localization module is used. If not running with the vital-localization module, the annotated bean will not be instantiated by Spring.

RequiresVitalMinigames

class RequiresVitalMinigames : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-minigames module is used. If not running with the vital-minigames module, the annotated bean will not be instantiated by Spring.

RequiresVitalPlayers

class RequiresVitalPlayers : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-players module is used. If not running with the vital-players module, the annotated bean will not be instantiated by Spring.

RequiresVitalScoreboards

class RequiresVitalScoreboards : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-scoreboards module is used. If not running with the vital-scoreboards module, the annotated bean will not be instantiated by Spring.

RequiresVitalStatistics

class RequiresVitalStatistics : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-statistics module is used. If not running with the vital-statistics module, the annotated bean will not be instantiated by Spring.

RequiresVitalTasks

class RequiresVitalTasks : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-tasks module is used. If not running with the vital-tasks module, the annotated bean will not be instantiated by Spring.

RequiresVitalUtils

class RequiresVitalUtils : Condition

Convenience-condition to mark a class to only be loaded as a bean, when the vital-utils module is used. If not running with the vital-utils module, the annotated bean will not be instantiated by Spring.

SpigotBStatsMetrics

typealias SpigotBStatsMetrics = Metrics

SpigotCancellable

typealias SpigotCancellable = Cancellable

SpigotCommandSender

typealias SpigotCommandSender = CommandSender

SpigotEvent

typealias SpigotEvent = Event

SpigotEventHandler

typealias SpigotEventHandler = EventHandler

SpigotEventPriority

typealias SpigotEventPriority = EventPriority

SpigotListener

typealias SpigotListener = Listener

SpigotPlayer

typealias SpigotPlayer = Player

SpigotPlugin

typealias SpigotPlugin = JavaPlugin

SpigotRunnable

typealias SpigotRunnable = BukkitRunnable

SpigotTask

typealias SpigotTask = BukkitTask

VitalBStatsInitialization

interface VitalBStatsInitialization<T> : InitializingBean

Internal interface; setups up bStats for Spigot and BungeeCord. By default, Vital enables bStats and sends its own metrics to it. To also include metrics for your own plugin, you must configure vital.core.bstats.plugin-id to your plugin id you got from bStats.

VitalCoreConfigurationProperties

@ConfigurationProperties(prefix = "vital.core")

@Component

class VitalCoreConfigurationProperties(val bstats: VitalCoreConfigurationProperties.BStats = BStats())

VitalCoreModule

class VitalCoreModule

VitalEntity

interface VitalEntity<T>

Defines an entity managed by a VitalRepository instance. The entity may be identified by the given generic type.

VitalHasInfo

interface VitalHasInfo

Should be used for classes that support an info annotation to provide metadata. To allow for multiple info annotations along the hierarchy path, this interface exposes a map of all registered info annotations.

VitalListener

interface VitalListener

Defines a listener within the Vital-Framework.

VitalListenerException

abstract class VitalListenerException(message: String, cause: Throwable) : RuntimeException

Internal exception; thrown during VitalListener lifecycles.

VitalModule

abstract class VitalModule : VitalHasInfo

A module includes additional features within the Vital ecosystem. Every module is essentially a Configuration and should define every module bean. Additionally, a module can also display what features are added, etc.

VitalModuleException

abstract class VitalModuleException(message: String, cause: Throwable? = null) : RuntimeException

Internal exception; thrown during VitalModule lifecycles.

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.

VitalPluginException

abstract class VitalPluginException(message: String) : RuntimeException

Internal exception; thrown when an error occurrs during VitalPlugin lifecycles.

VitalRepository

abstract class VitalRepository<T : VitalEntity<ID>, ID>

A volatile in-memory repository to store temporary data in a Spring-like repository implementation. It can store implementations of VitalEntity and the means to get, save and delete them.

VitalResourceLoader

class VitalResourceLoader : DefaultResourceLoader

Internal spring resource loader responsible for locating resources in the spring context. Will strip any protocol from requested resources to enable correct resource loading.

VitalShutdownHandler

interface VitalShutdownHandler : InitializingBean

Internal handler; responsible for gracefully shutting down Vital when server shutdown is requested.

VitalSpringConfiguration

class VitalSpringConfiguration

Main spring configuration for the implementing plugin. Exposes the plugin as a bean to fix classpath scanning errors when ide scans for beans.