Aliucord/com.aliucord.entities/Plugin

Plugin

abstract class Plugin

The base class that all plugins must extend from for their entrypoint.

Constructors

constructor()

Types

Plugin Manifest

class SettingsTab

Plugin SettingsTab

Properties

var __filename: String?

The filename of the zip this plugin was loaded from

@get:JvmName(name = "getAnnotation")

val annotation: AliucordPlugin?

Returns the @AliucordPlugin on this class annotation if it exists.

val logger: Logger

The Logger of your plugin. Use this to log information

@get:JvmName(name = "getManifest")

val manifest: Plugin.Manifest

Method returning the Manifest of your Plugin

@get:JvmName(name = "getName")

val name: String

The name of this plugin as known by the updater. The name of this class does not necessarily have to match.

var ~~needsResources~~: Boolean

Whether your plugin has resources that need to be loaded

var resources: Resources?

The resources of your plugin.

val settings: SettingsAPI

The SettingsAPI of your plugin. Use this to store persistent data

var settingsTab: Plugin.SettingsTab?

SettingsTab associated with this plugin. Set this to register a settings page

Functions

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. This is toggleable through the @AliucordPlugin annotation. You should not override this method yourself.

open fun start(context: Context)

Called when your Plugin is started

open fun stop(context: Context)

Called when your Plugin is stopped

open fun unload(context: Context)

Called when your Plugin is unloaded