Aliucord/com.aliucord.entities/Plugin

Plugin

abstract class Plugin

Base Plugin class all plugins must extend

Constructors

Plugin

constructor(manifest: Plugin.Manifest)

constructor()

Types

Manifest

open class Manifest

Plugin Manifest

SettingsTab

open class SettingsTab

Plugin SettingsTab

Functions

getAnnotation

@Nullable

open fun getAnnotation(): AliucordPlugin

Returns the @AliucordPlugin annotation if exists

getName

open fun getName(): String

load

open fun load(context: Context)

Called when your Plugin is loaded

requiresRestart

open fun requiresRestart(): Boolean

Returns whether the user will be prompted to restart after enabling/disabling.

start

abstract fun start(context: Context)

Called when your Plugin is started

stop

abstract fun stop(context: Context)

Called when your Plugin is stopped

unload

open fun unload(context: Context)

Called when your Plugin is unloaded

Properties

__filename

open var __filename: String

The filename of your plugin

logger

val logger: Logger

The Logger of your plugin.

manifest

@get:NonNull

open val manifest: Plugin.Manifest

needsResources

open var needsResources: Boolean

Whether your plugin has resources that need to be loaded

resources

open var resources: Resources

The resources of your plugin.

settings

val settings: SettingsAPI

The SettingsAPI of your plugin.

settingsTab

open var settingsTab: Plugin.SettingsTab

SettingsTab associated with this plugin.