UnderscoreEnchantsAPI/com.roughlyunderscore.data/RequiredPlugin

RequiredPlugin

@Since(version = "2.2")

data class RequiredPlugin(val pluginName: String, val displayName: String, val link: String) : Describable<RequiredPlugin>

This object represents a plugin that is required for an enchantment to load. This is used to ensure that the enchantment that depends on some other plugin (e.g. a provider of new actions) is not loaded if the plugin is not present.

Constructors

RequiredPlugin

constructor(pluginName: String, displayName: String, link: String)

Types

Companion

object Companion

Properties

displayName

val displayName: String

This field resembles an arbitrary string, which is displayed to the user browsing enchantments/packs. It is recommended to use the name of the plugin and a minimal version (e.g. PlaceholderAPI 2.10.9+), but it is not required.

link

val link: String

This is the link to the plugin's page. This is used to direct the user to the plugin's page in case the plugin is not installed.

pluginName

val pluginName: String

This is the name of the required plugin. This name must exactly match the name of the plugin that is required for the enchantment to load.

Functions

getDescriber

open override fun getDescriber(): Describer<RequiredPlugin>

Gets the describer for the object.