PluginObject

Methods
5
Fields
None

Getting one

Plugin.new(…)
InfoBox.new(…):getPlugin()

Methods

MethodReturnsDescription
startUp()()Runs on every enable, before any event. Override it.
shutDown()()Runs on every disable, after the plugin is unregistered. Override it.
resetConfiguration()()Runs on the settings page's Reset. Override it to clear what the plugin keeps outside its config group.
getName()string?The descriptor's name.
getId()string?The plugin's id (its package folder's name).

Returned by

MethodReturnsDescription
InfoBox.getPluginPluginObject?The plugin it was made with: the manager orders a priority's boxes by its name.
PluginChanged.getPluginPluginObjectThe plugin (this one as itself, another as its handle).
PluginClass.newPluginObjectBuilds the plugin object. Its optional table is the plugin's descriptor (see PluginDescriptor). Field initialisers and one-time setup bel…
PluginManager.conflictsForPlugin{PluginObject}Every other plugin whose name, or any of whose conflicts, is this plugin's name or in its conflicts.
PluginManager.getPlugins{PluginObject}Every plugin, in load order: this one as itself, each other one as its object (a local plugin's as a view, to a marketplace plugin) or its…

Method details

shutDown

shutDown: (PluginObject) -> ()

Runs on every disable, after the plugin is unregistered. Override it.

resetConfiguration

resetConfiguration: (PluginObject) -> ()

Runs on the settings page's Reset. Override it to clear what the plugin keeps outside its config group.