PluginDescription

Represents the plugin.conf file that every plugin has.

This holds details about the plugin, for example it's name, main class, version, description, authors and dependencies.

Functions

Link copied to clipboard

Gets the plugin dependency with the given id, or returns null if there is no dependency with the given id.

Properties

Link copied to clipboard
@get:JvmName(name = "authors")
abstract val authors: Collection<String>

The list of people who created this plugin.

Link copied to clipboard
@get:JvmName(name = "dependencies")
abstract val dependencies: Collection<PluginDependency>

The list of dependencies of this plugin.

Link copied to clipboard
@get:JvmName(name = "description")
abstract val description: String

A short description of this plugin.

Link copied to clipboard
@get:JvmName(name = "id")
abstract val id: String

The unique ID of this plugin.

Link copied to clipboard
@get:JvmName(name = "name")
abstract val name: String

The name of this plugin. Defaults to empty.

Link copied to clipboard
@get:JvmName(name = "source")
abstract val source: Path?

The source path that this plugin was loaded from, or null if this plugin was not loaded from a file.

Link copied to clipboard
@get:JvmName(name = "version")
abstract val version: String

The version of this plugin. Defaults to .