Interface IPlugin

Namespace

Elegy.Common.Interfaces

Assembly

Elegy.Common.dll

Generic plugin interface.

public interface IPlugin

Properties

Error

If Init() returned false, the error message.

string Error { get; }

Property Value

string

Initialised

Set by Init() once initialisation succeeds.

bool Initialised { get; }

Property Value

bool

Name

The name of this plugin.

string Name { get; }

Property Value

string

Methods

Init()

Called when the plugin is being initialised.

bool Init()

Returns

bool

Shutdown()

Called when the engine and plugins are shutting down.

void Shutdown()