Table of Contents

Namespace OnixRuntime.Plugin

Classes

OnixPluginBase

Base class for Onix plugins, providing access to plugin manifest, asset paths, persistent data, and lifecycle events.

OnixPluginInitInfo

Contains initialization information for an Onix plugin, including manifest, asset paths, persistent data, cancellation, and bound DLLs.

OnixPluginInstaller

Handles installing, uninstalling, packaging and managing plugins asynchronously. Provides methods to start operations and track progress via TaskProgressReport.

OnixPluginInstaller.TaskProgressReport

Represents progress and status for a long-running plugin operation.

OnixPluginSaveManager

Class responsible for saving and loading onix module data in plugins. This is for the default setting system, you can go the manual route of course.

PluginManifest

Represents the manifest for an Onix plugin, including metadata such as UUID, name, author, description, versions, and target assembly.

PluginManifestJson

Internal class representing the JSON structure of a plugin manifest.

PluginSettings

Represents plugin settings, including whether the plugin is enabled and should load.

PluginStateExtensions

Extensions to add some convenience methods to the PluginState.

PublicPluginManager

Wrapper allowing you to access public plugin data.

RemotePluginManifest

A PluginManifest that includes the original remote source URL the manifest was retrieved from.

RuntimeManifest

Represents the runtime manifest, including runtime version information.

SupportedVersionRange

Represents a range of supported versions, either a single version or a range of versions.

Interfaces

IOnixPlugin

A basic onix plugin interface to interact with other plugins.

Enums

PluginLoadMode

Specifies the various modes for loading plugins.

PluginState

Represents the various states a plugin can be in.

Delegates

OnixPluginSaveManager.OnConfigLoadDelegate

Delegate for handling configuration load events. This is going to be what you gave in ConfigSaved.

OnixPluginSaveManager.OnConfigSaveDelegate

Delegate for handling configuration save events. Return a JSON representation of what you need to save, it will be given back in ConfigLoaded