Interface Plugin

Represents a plugin.

Hierarchy

Plugin

Index

Properties

Methods

Properties

authors

authors: string[] | EntityAuthor[]

Authors of the plugin.

Optional color

color?: string

Color of the plugin in settings.

Optional commands

commands?: Command[]

List of commands of the plugin.

description

description: string

Description of the plugin.

name

name: string

Name of the plugin.

Optional patches

patches?: Patcher[]

List of patchers of the plugin.

version

version: string

Version of the plugin.

Methods

Optional getSettingsPanel

getSettingsPanel(props: { settings: SettingsStore }): ComponentType<{}>

- Defined in lib/managers/plugins.ts:50
Settings panel of the plugin.

Parameters
- props: { settings: SettingsStore }
  - settings: SettingsStore
Returns ComponentType<{}>

Optional onDisable

onDisable(): void

- Defined in lib/managers/plugins.ts:78
Executed when the plugin is disabled.

This method is overwritten by Enmity to do internal stuff.

DO NOT OVERRIDE THIS.

Returns void

Optional onEnable

onEnable(): void

- Defined in lib/managers/plugins.ts:69
Executed when the plugin is enabled.

This method is overwritten by Enmity to do internal stuff.

DO NOT OVERRIDE THIS.

Returns void

onStart

onStart(): void

- Defined in lib/managers/plugins.ts:55
Executed when the plugin is started.

Returns void

onStop

onStop(): void

- Defined in lib/managers/plugins.ts:60
Executed when the plugin is stopped.

Returns void

Generated using TypeDoc