Class PluginMetadata

A class which describes a loaded plugin.

Inheritance
Object
PluginMetadata
Inherited Members
Namespace: IPA.Loader
Assembly: IPA.Loader.dll
Syntax
public class PluginMetadata

Properties

| Improve this Doc View Source

Assembly

The assembly the plugin was loaded from.

Declaration
public Assembly Assembly { get; }
Property Value
Type Description
Assembly

the loaded Assembly that contains the plugin main type
| Improve this Doc View Source

AssociatedFiles

A list of files (that aren't File) that are associated with this plugin.

Declaration
public IReadOnlyList<FileInfo> AssociatedFiles { get; }
Property Value
Type Description
IReadOnlyList<FileInfo>

a list of associated files
| Improve this Doc View Source

Author

The name of the author that wrote this plugin.

Declaration
public string Author { get; }
Property Value
Type Description
String

the name of the plugin's author
| Improve this Doc View Source

Features

The features this plugin requests.

Declaration
public IReadOnlyList<Feature> Features { get; }
Property Value
Type Description
IReadOnlyList<Feature>

the list of features requested by the plugin
| Improve this Doc View Source

File

The file the plugin was loaded from.

Declaration
public FileInfo File { get; }
Property Value
Type Description
FileInfo

the file the plugin was loaded from
| Improve this Doc View Source

Id

The BeatMods ID of the plugin, or null if it doesn't have one.

Declaration
public string Id { get; }
Property Value
Type Description
String

the updater ID of the plugin
| Improve this Doc View Source

IsBare

Whether or not this metadata object represents a bare manifest.

Declaration
public bool IsBare { get; }
Property Value
Type Description
Boolean

true if it is bare, false otherwise
| Improve this Doc View Source

Name

The human readable name of the plugin.

Declaration
public string Name { get; }
Property Value
Type Description
String

the name of the plugin
| Improve this Doc View Source

PluginType

The TypeDefinition for the main type of the plugin.

Declaration
public TypeDefinition PluginType { get; }
Property Value
Type Description
TypeDefinition

the Cecil definition for the plugin main type
| Improve this Doc View Source

RuntimeOptions

The RuntimeOptions that the plugin specified in its PluginAttribute.

Declaration
public RuntimeOptions RuntimeOptions { get; }
Property Value
Type Description
RuntimeOptions
| Improve this Doc View Source

Version

The version of the plugin.

Declaration
public SemVer.Version Version { get; }
Property Value
Type Description
SemVer.Version

the version of the plugin

Methods

| Improve this Doc View Source

ToString()

Gets all of the metadata as a readable string.

Declaration
public override string ToString()
Returns
Type Description
String

the readable printable metadata string
Overrides

Extension Methods