pluginManager

Methods
9
Fields
None

Getting one

pluginManager

Methods

MethodReturnsDescription
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…
isPluginEnabled(plugin: PluginObject)booleanThe saved choice, else enabledByDefault.
isPluginActive(plugin: PluginObject)booleanRunning: started, not stopped since.
setPluginEnabled(plugin: PluginObject, enabled: boolean)()Save the plugin's choice (enabling switches its conflicts off), starting or stopping nothing. Any plugin's, this one's or another's.
startPlugin(plugin: PluginObject)booleanStart the plugin when it is enabled and not running, its conflicts stopped first. From a callback it runs at the next safe point and answer…
stopPlugin(plugin: PluginObject)booleanStop the plugin (unregistered, then shutDown); it stays enabled, and stopped. As startPlugin, from a callback at the next safe point, n…
conflictsForPlugin(plugin: PluginObject){PluginObject}Every other plugin whose name, or any of whose conflicts, is this plugin's name or in its conflicts.
getPluginConfigProxy(plugin: PluginObject)anyThe plugin's own config proxy, or nil when it declared none (a first-party plugin has none). Another plugin's proxy reads and writes that p…
getPluginDescriptor(plugin: PluginObject)PluginDescriptorA plugin's descriptor, its fields as methods (see PluginDescriptor).

Method details

getPlugins

getPlugins: (PluginManager) -> {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 stand-in.

setPluginEnabled

setPluginEnabled: (PluginManager, plugin: PluginObject, enabled: boolean) -> ()

Save the plugin's choice (enabling switches its conflicts off), starting or stopping nothing. Any plugin's, this one's or another's.

startPlugin

startPlugin: (PluginManager, plugin: PluginObject) -> boolean

Start the plugin when it is enabled and not running, its conflicts stopped first. From a callback it runs at the next safe point and answers true (queued). Any plugin, this one or another.

stopPlugin

stopPlugin: (PluginManager, plugin: PluginObject) -> boolean

Stop the plugin (unregistered, then shutDown); it stays enabled, and stopped. As startPlugin, from a callback at the next safe point, never inside the plugin's own callback, task or render; answers true (queued). Any plugin, this one or another.

getPluginConfigProxy

getPluginConfigProxy: (PluginManager, plugin: PluginObject) -> any

The plugin's own config proxy, or nil when it declared none (a first-party plugin has none). Another plugin's proxy reads and writes that plugin's group, as configManager does: a secret item answers its own plugin only. A marketplace plugin holds a local plugin's proxy through a view.