Murl Engine Lua Addon API  Version 1.0 beta
Murl.IAddon

The add-on interface.

An add-on represents an optionally linkable component that can be used to extend the engine's functionality, e.g. the Facebook integration.


Table members

Methods


GetName()

Get the addon's name.

String GetName()

Returns
String The addon's name.

Configure(engineConfig, fileInterface)

Configure the addon. This method is called by the engine right after IApp::RegisterCustomAddonClasses() is called, in order to apply any add-on specific settings to the engine and/or app configuration. Note that this is happening after IApp::Configure() gets called, so these settings are not yet available in during IApp::Configure().

Boolean Configure(Murl.IEngineConfiguration engineConfig, Murl.IFileInterface fileInterface)

Parameters
engineConfigThe engine configuration object.
fileInterfaceThe file interface object.
Returns
Boolean true if successful.

Init(appState)

Initialize the add-on. This method is called by the engine core for add-on initialization, immediately before the application is initialized. See IApp::Init().

Boolean Init(Murl.IAppState appState)

Parameters
appStateThe application state object.
Returns
Boolean true if successful.

DeInit(appState)

Deinitialize the add-on. This method is called by the engine core for application deinitialization, immediately after the application is de-initialized. See IApp::DeInit().

Boolean DeInit(Murl.IAppState appState)

Parameters
appStateThe application state object.
Returns
Boolean true if successful.