Overview
The PluginManager class is the core plugin manager responsible for loading and managing plugin extensions in Frosty Toolsuite. It discovers plugins from the Plugins/ directory, validates them, and provides access to various extension types.
Constructor
PluginManager
public PluginManager(ILogger logger, PluginManagerType context)
The logging interface the plugin manager should use
context
PluginManagerType
required
The context which this plugin should load for (Editor, ModManager, or Both)
var logger = new MyLogger();
var pluginManager = new PluginManager(logger, PluginManagerType.Editor);
Properties
ManagerType
public PluginManagerType ManagerType { get; }
Plugins
public IEnumerable<Plugin> Plugins { get; }
LoadedPlugins
public IEnumerable<Plugin> LoadedPlugins { get; }
public IEnumerable<MenuExtension> MenuExtensions { get; }
TabExtensions
public IEnumerable<TabExtension> TabExtensions { get; }
public IEnumerable<DataExplorerContextMenuExtension> DataExplorerContextMenuExtensions { get; }
ExecutionActions
public IEnumerable<ExecutionAction> ExecutionActions { get; }
OptionsExtensions
public IEnumerable<Type> OptionsExtensions { get; }
Profiles
public IEnumerable<Profile> Profiles { get; }
StartupActions
public IEnumerable<StartupAction> StartupActions { get; }
Methods
Initialize
Initializes all post-profile assembly plugins. This method must be called after the game profile is loaded to initialize profile-specific plugins.
pluginManager.Initialize();
GetAssetDefinition
public AssetDefinition GetAssetDefinition(string type)
AssetDefinition for the specified asset type.
The type of the asset definition to obtain (case-insensitive)
The AssetDefinition for the specified type, or null if not found
AssetDefinition meshDef = pluginManager.GetAssetDefinition("MeshAsset");
if (meshDef != null)
{
var editor = meshDef.GetEditor(logger);
}
GetTypeEditor
public Type GetTypeEditor(string lookupName)
The lookup name of the type editor to obtain (case-insensitive)
The Type of the type editor, or null if not found
Type editorType = pluginManager.GetTypeEditor("Vec3");
if (editorType != null)
{
var editor = Activator.CreateInstance(editorType);
}
GetTypeOverride
public Type GetTypeOverride(string lookupName)
The lookup name of the type override to obtain (case-insensitive)
The Type of the type override, or null if not found
GetCustomHandler
public ICustomActionHandler GetCustomHandler(string ebxType)
public ICustomActionHandler GetCustomHandler(uint handlerHash)
public ICustomActionHandler GetCustomHandler(ResourceType resType)
The EBX type name to get a handler for
The FNV1 hash of the EBX type
The resource type to get a handler for
A new instance of the custom handler, or null if not found
// Get handler by EBX type name
var handler = pluginManager.GetCustomHandler("MeshAsset");
// Get handler by resource type
var resHandler = pluginManager.GetCustomHandler(ResourceType.MeshSet);
GetPluginAssembly
public Assembly GetPluginAssembly(string name)
The name of the plugin to obtain
The Assembly of the plugin, or null if not found
Assembly meshPlugin = pluginManager.GetPluginAssembly("MeshSetPlugin");
if (meshPlugin != null)
{
// Use plugin assembly
}
GetLocalizedStringDatabase
public ILocalizedStringDatabase GetLocalizedStringDatabase()
The constructed localized string database instance
GetShader
public byte[] GetShader(ShaderType type, string name)
The type of shader (VertexShader, PixelShader, or ComputeShader)
The resource name of the shader
The bytecode of the shader, or null if not found
byte[] vertexShader = pluginManager.GetShader(ShaderType.VertexShader, "MeshShader");
byte[] pixelShader = pluginManager.GetShader(ShaderType.PixelShader, "MeshShader");
GetUserShaders
public IEnumerable<string> GetUserShaders()
Collection of user shader descriptors
IsThirdPartyDll
public bool IsThirdPartyDll(string name)
The name of the DLL to check (case-insensitive)
True if the DLL is registered as third-party
IsManagerType
public bool IsManagerType(PluginManagerType type)
type
PluginManagerType
required
The manager type to check (Editor, ModManager, or Both)
True if the manager type matches
if (pluginManager.IsManagerType(PluginManagerType.Editor))
{
// Editor-specific code
}
LoadPlugin
public Plugin LoadPlugin(string pluginPath, PluginLoadType? loadType = null)
The path to the target plugin DLL
Optional. Determines what should be loaded from the plugin (Startup or Initialize)
A Plugin instance. Check the Status property for load success/failure
Plugin plugin = pluginManager.LoadPlugin("Plugins/MyPlugin.dll", PluginLoadType.Startup);
if (plugin.Status == PluginLoadStatus.Loaded)
{
logger.Log($"Plugin {plugin.Assembly.GetName().Name} loaded successfully");
}
else if (plugin.LoadException != null)
{
logger.LogError($"Failed to load plugin: {plugin.LoadException.Message}");
}
Enumerations
PluginManagerType
public enum PluginManagerType
{
Editor,
ModManager,
Both
}
PluginLoadType
public enum PluginLoadType
{
Startup,
Initialize
}
- Startup: Loaded before profile initialization (profiles, type overrides, global editors)
- Initialize: Loaded after profile initialization (asset definitions, menu extensions, handlers)
PluginLoadStatus
public enum PluginLoadStatus
{
Loaded,
LoadedInvalid,
FailedToLoad
}
See Also