OpenMod Docs OpenMod Docs
OpenMod Docs OpenMod Docs
OpenMod .NET Plugin Framework.

Class PluginMetadataAttribute

Provides metadata for plugins. Assemblies which do not have this attribute will not be loaded as plugins.

Inheritance
System.Object
PluginMetadataAttribute
Namespace: OpenMod.API.Plugins
Assembly: OpenMod.API.dll
Syntax
public sealed class PluginMetadataAttribute : Attribute

Constructors

| Improve this Doc View Source

PluginMetadataAttribute(String)

Declaration
public PluginMetadataAttribute(string id)
Parameters
Type Name Description
System.String id

Properties

| Improve this Doc View Source

Author

Gets or sets the author of the plugin.

Declaration
public string? Author { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Description

Gets or sets the description of the plugin.

Declaration
public string? Description { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

DisplayName

Gets or sets the human-readable name of the plugin.

Declaration
public string? DisplayName { get; set; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Id

Gets or sets the plugin ID. Must start with a letter and can only contain alphanumeric characters including dots.

Declaration
public string Id { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Website

Gets or sets the website of the plugin.

Declaration
public string? Website { get; set; }
Property Value
Type Description
System.Nullable<System.String>

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)