SwiftlyS2

IPluginManager

Interface IPluginManager

Namespace: SwiftlyS2.Shared.Plugins

Assembly: SwiftlyS2.CS2.dll

public interface IPluginManager

Methods

GetAllPluginMetadata()

Gets a dictionary of all plugin metadata, keyed by plugin ID.

Dictionary<string, PluginMetadata> GetAllPluginMetadata()
Returns

GetAllPluginStatuses()

Gets a dictionary of all plugin statuses, keyed by plugin ID.

Dictionary<string, PluginStatus> GetAllPluginStatuses()
Returns

GetAllPlugins()

Gets a list of all plugin IDs.

IEnumerable<string> GetAllPlugins()
Returns

GetPluginMetadata(string)

Gets the metadata of the specified plugin.

PluginMetadata? GetPluginMetadata(string pluginId)
Parameters
  • pluginId string — The ID of the plugin.
Returns

GetPluginPath(string)

Gets the path of the specified plugin.

string? GetPluginPath(string pluginId)
Parameters
  • pluginId string — The ID of the plugin.
Returns

GetPluginPaths()

Gets a dictionary of all plugin paths, keyed by plugin ID.

Dictionary<string, string> GetPluginPaths()
Returns

GetPluginStatus(string)

Gets the status of the specified plugin.

PluginStatus? GetPluginStatus(string pluginId)
Parameters
  • pluginId string — The ID of the plugin.
Returns

LoadPlugin(string, bool)

Loads the specified plugin.

bool LoadPlugin(string pluginId, bool silent = false)
Parameters
  • pluginId string — The ID of the plugin.
  • silent bool — If true, suppresses any error messages.
Returns
  • bool — True if the plugin was loaded successfully, false otherwise.

ReloadPlugin(string, bool)

Reloads the specified plugin.

bool ReloadPlugin(string pluginId, bool silent = false)
Parameters
  • pluginId string — The ID of the plugin.
  • silent bool — If true, suppresses any error messages.
Returns
  • bool — True if the plugin was reloaded successfully, false otherwise.

UnloadPlugin(string, bool)

Unloads the specified plugin.

bool UnloadPlugin(string pluginId, bool silent = false)
Parameters
  • pluginId string — The ID of the plugin.
  • silent bool — If true, suppresses any error messages.
Returns
  • bool — True if the plugin was unloaded successfully, false otherwise.

On this page