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

Interface IOpenModComponent

Defines an OpenMod component. Components are either plugins or OpenMod assemblies.

Namespace: OpenMod.API
Assembly: OpenMod.API.dll
Syntax
public interface IOpenModComponent

Properties

| Improve this Doc View Source

DataStore

Gets the optional data store of the component.

Declaration
IDataStore DataStore { get; }
Property Value
Type Description
IDataStore
| Improve this Doc View Source

IsComponentAlive

Checks if the component is alive. The component must not be able to execute any actions if this returns false.

Declaration
bool IsComponentAlive { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LifetimeScope

Gets the components lifetime scope.

Declaration
ILifetimeScope LifetimeScope { get; }
Property Value
Type Description
ILifetimeScope
| Improve this Doc View Source

OpenModComponentId

Gets the component ID.

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

WorkingDirectory

Gets the working directory.

Declaration
string WorkingDirectory { get; }
Property Value
Type Description
System.String

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)