mirai-console/net.mamoe.mirai.console.plugin/Plugin

Plugin

interface Plugin : CommandOwner

表示一个 mirai-console 插件.

See also

net.mamoe.mirai.console.plugin.PluginManager

禁用一个插件

net.mamoe.mirai.console.plugin.PluginManager.INSTANCE

获取一个插件的描述

net.mamoe.mirai.console.plugin.description.PluginDescription

插件描述，需由 PluginLoader 帮助提供（PluginLoader.getPluginDescription）

net.mamoe.mirai.console.plugin.jvm.JvmPlugin

Java, Kotlin 或其他 JVM 平台插件

net.mamoe.mirai.console.plugin.PluginFileExtensions

支持文件系统存储的扩展

net.mamoe.mirai.console.plugin.loader.PluginLoader

插件加载器

Functions

permissionId

abstract fun permissionId(name: String): PermissionId

创建一个此命名空间下的 PermitteeId.

Properties

isEnabled

abstract val isEnabled: Boolean

当插件已启用时返回 true, 否则表示插件未启用.

loader

abstract val loader: PluginLoader<*, *>

所属插件加载器实例, 此加载器必须能加载这个 Plugin.

parentPermission

abstract val parentPermission: Permission

在构造指令时, Command.permission 默认会使用 parentPermission 作为 Permission.parent

Inheritors

JvmPlugin

Extensions

author

val Plugin.author: String

获取 PluginDescription.author

dependencies

val Plugin.dependencies: Set<PluginDependency>

获取 PluginDescription.dependencies

description

~~val~~ Plugin.~~description~~: PluginDescription

val Plugin.description: PluginDescription

disable

inline fun Plugin.disable()

enable

inline fun Plugin.enable()

id

val Plugin.id: String

获取 PluginDescription.id

info

val Plugin.info: String

获取 PluginDescription.info

load

inline fun Plugin.load()

name

val Plugin.name: String

获取 PluginDescription.name

version

val Plugin.version: SemVersion

获取 PluginDescription.version