startUp
startUp: (PluginObject) -> ()Runs on every enable, before any event. Override it.
Plugin.new(…)
InfoBox.new(…):getPlugin()| Method | Returns | Description |
|---|---|---|
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). |
| Method | Returns | Description |
|---|---|---|
InfoBox.getPlugin | PluginObject? | The plugin it was made with: the manager orders a priority's boxes by its name. |
PluginChanged.getPlugin | PluginObject | The plugin (this one as itself, another as its handle). |
PluginClass.new | PluginObject | Builds 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… |
startUpstartUp: (PluginObject) -> ()Runs on every enable, before any event. Override it.
shutDownshutDown: (PluginObject) -> ()Runs on every disable, after the plugin is unregistered. Override it.
resetConfigurationresetConfiguration: (PluginObject) -> ()Runs on the settings page's Reset. Override it to clear what the plugin keeps outside its config group.
getNamegetName: (PluginObject) -> string?The descriptor's name.
getIdgetId: (PluginObject) -> string?The plugin's id (its package folder's name).