Class DevConsoleFrontend

Namespace
Elegy.DevConsole
Assembly
Elegy.DevConsole.dll
public class DevConsoleFrontend : IConsoleFrontend, IPlugin
Inheritance
DevConsoleFrontend
Implements
Inherited Members

Constructors

DevConsoleFrontend()

public DevConsoleFrontend()

Properties

Error

If Init() returned false, the error message.

public string Error { get; set; }

Property Value

string

Initialised

Set by Init() once initialisation succeeds.

public bool Initialised { get; set; }

Property Value

bool

Name

The name of this plugin.

public string Name { get; }

Property Value

string

Methods

Init()

Called when the plugin is being initialised.

public bool Init()

Returns

bool

OnLog(string, ConsoleMessageType, float)

A message is being logged. Write it down. Console frontends should never use methods from Elegy.Console, else you get an infinite loop.

public void OnLog(string message, ConsoleMessageType type, float timeSubmitted)

Parameters

message string
type ConsoleMessageType
timeSubmitted float

OnUpdate(float)

Called every frame to update the console frontend, in case it may be interactive or have some animations.

public void OnUpdate(float delta)

Parameters

delta float

Shutdown()

Called when the engine and plugins are shutting down.

public void Shutdown()