Skip to content

Plugin Events

Description

Can be used through PluginEventService in dependency injection.

Plugin Loaded Event

Description:

  • Triggered after plugin loading is complete
  • Later than the Loaded function in the plugin class
  • Earlier than the Enabled function in the plugin class
  • Earlier than the PluginEnabled event

Trigger conditions:

  • When plugin is loaded for the first time (even in disabled state)

Parameters: PluginEventArgs

  • PluginId Plugin ID
  • Status Status, fixed as PluginStatus.Loaded

Plugin Enabled Event

Description:

  • Triggered after plugin is enabled
  • Later than the Enabled function in the plugin class

Trigger conditions:

  • Plugin not loaded -> enabled
  • Plugin disabled -> enabled

Parameters: PluginEventArgs

  • PluginId Plugin ID
  • Status Status, fixed as PluginStatus.Enabled

Plugin Disabled Event

Description:

  • Triggered after plugin is disabled
  • Later than the Disabled function in the plugin class

Trigger conditions:

  • Plugin not loaded -> disabled
  • Plugin enabled -> disabled

Parameters: PluginEventArgs

  • PluginId Plugin ID
  • Status Status, fixed as PluginStatus.Disabled

Plugin Plan Upgrade Event

Description:

  • Triggered when plugin upgrade is planned

Trigger conditions:

  • Plugin upgrade planned

Parameters: PluginEventArgs

  • PluginId Plugin ID
  • Status Status, fixed as PluginStatus.PlanUpgrade

Plugin Upgraded Event

Description:

  • Triggered when plugin upgrade is complete

Trigger conditions:

  • Plugin upgrade complete (usually after program restart)

Parameters: PluginEventArgs

  • PluginId Plugin ID
  • Status Status, fixed as PluginStatus.Upgraded

Plugin Plan Remove Event

Description:

  • Triggered when plugin removal is planned

Trigger conditions:

  • Plugin removal planned

Parameters: PluginEventArgs

  • PluginId Plugin ID
  • Status Status, fixed as PluginStatus.PlanRemove

Plugin Removed Event

Description:

  • Triggered when plugin removal is complete

Trigger conditions:

  • Plugin removal complete (usually after program restart)

Parameters: PluginEventArgs

  • PluginId Plugin ID
  • Status Status, fixed as PluginStatus.Removed