API Reference / api/plugin/Plugin / Plugin

Interface: Plugin

Defined in: api/plugin/Plugin.d.ts:7

Hideconstructor

插件实例

Methods

getDataFolder()

getDataFolder(): string

Defined in: api/plugin/Plugin.d.ts:84

返回插件数据文件的位置。文件可能尚未存在。

Returns

string

文件夹

---

getDescription()

getDescription(): PluginDescription

Defined in: api/plugin/Plugin.d.ts:15

返回这个插件的详细信息。

Returns

PluginDescription

插件的详细信息。

---

getLogger()

getLogger(): Logger

Defined in: api/plugin/Plugin.d.ts:39

返回此服务器的日志记录器。返回的日志记录器自动为所有日志消息标记插件的名称。

Returns

Logger

关联于此插件的日志记录器

---

getName()

getName(): string

Defined in: api/plugin/Plugin.d.ts:69

返回插件的名称。

应该返回插件的原始名称，并应用于比较。

Returns

string

插件的名称

---

getServer()

getServer(): Server

Defined in: api/plugin/Plugin.d.ts:60

返回当前运行此插件的服务器实例。

Returns

Server

正在运行此插件的服务器实例

---

isEnabled()

isEnabled(): boolean

Defined in: api/plugin/Plugin.d.ts:46

返回一个值，指示当前插件是否已启用。

Returns

boolean

如果此插件已启用，则返回true；否则返回false

---

onDisable()

onDisable(): void

Defined in: api/plugin/Plugin.d.ts:32

插件禁用后被调用。

Returns

void

---

onEnable()

onEnable(): void

Defined in: api/plugin/Plugin.d.ts:27

插件启用后被调用。

Returns

void

---

onLoad()

onLoad(): void

Defined in: api/plugin/Plugin.d.ts:22

模块加载后但在启用之前被调用。

当多个插件加载时，所有插件的onLoad()方法在任何onEnable()方法之前被调用。

Returns

void

---

toString()

toString(): "<Plugin>"

Defined in: api/plugin/Plugin.d.ts:8

Returns

"<Plugin>"