Interface IOpenModPlugin

Represents an OpenMod plugin.

Inherited Members
Namespace: OpenMod.API.Plugins
Assembly: OpenMod.API.dll
Syntax
public interface IOpenModPlugin : IOpenModComponent

Properties

| Improve this Doc View Source

Author

Gets the plugin author.

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

Description

Gets the plugin description

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

DisplayName

Gets the human readable name of the plugin.

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

Version

Gets the plugin version.

Declaration
SemVersion Version { get; }
Property Value
Type Description
SemVersion
| Improve this Doc View Source

Website

Gets the plugin website.

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

Methods

| Improve this Doc View Source

LoadAsync()

Loads the plugin.

Declaration
Task LoadAsync()
Returns
Type Description
Task
Remarks

This method is for internal usage only and should not be used by plugins.

| Improve this Doc View Source

UnloadAsync()

Unloads the plugin.

Declaration
Task UnloadAsync()
Returns
Type Description
Task
Remarks

This method is for internal usage only and should not be used by plugins.

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)