plugify::ILanguageModule Class Reference

Interface for user-implemented language modules. More...

#include <language_module.hpp>

Public Member Functions
virtual InitResult	Initialize (std::weak_ptr< IPlugifyProvider > provider, ModuleHandle module)=0
	Initialize the language module.
virtual void	Shutdown ()=0
	Shutdown the language module.
virtual void	OnUpdate (DateTime dt)=0
	Handle actions to be performed on each frame.
virtual LoadResult	OnPluginLoad (PluginHandle plugin)=0
	Handle plugin load event.
virtual void	OnPluginStart (PluginHandle plugin)=0
	Handle plugin start event.
virtual void	OnPluginUpdate (PluginHandle plugin, DateTime dt)=0
	Handle plugin update event.
virtual void	OnPluginEnd (PluginHandle plugin)=0
	Handle plugin end event.
virtual void	OnMethodExport (PluginHandle plugin)=0
	Handle method export event.
virtual bool	IsDebugBuild ()=0
	Determine if language module is build with debugging mode.

Detailed Description

Interface for user-implemented language modules.

The ILanguageModule interface defines methods that should be implemented by user-written language modules.

Definition at line 81 of file language_module.hpp.

Member Function Documentation

Initialize()

virtual InitResult plugify::ILanguageModule::Initialize ( std::weak_ptr< IPlugifyProvider >  provider, ModuleHandle  module  )

pure virtual

Initialize the language module.

Parameters

provider	Weak pointer to the Plugify provider.
module	Handle to the language module being initialized.

Returns

Result of the initialization, either InitResultData or ErrorData.

IsDebugBuild()

virtual bool plugify::ILanguageModule::IsDebugBuild ( )

pure virtual

Determine if language module is build with debugging mode.

Returns

True if the assembly is build with debugging, false otherwise.

OnMethodExport()

virtual void plugify::ILanguageModule::OnMethodExport ( PluginHandle  plugin )

pure virtual

Handle method export event.

Parameters

plugin

Handle to the plugin exporting a method.

OnPluginEnd()

virtual void plugify::ILanguageModule::OnPluginEnd ( PluginHandle  plugin )

pure virtual

Handle plugin end event.

Parameters

plugin

Handle to the ended plugin.

OnPluginLoad()

virtual LoadResult plugify::ILanguageModule::OnPluginLoad ( PluginHandle  plugin )

pure virtual

Handle plugin load event.

Parameters

plugin

Handle to the loaded plugin.

Returns

Result of the load event, either LoadResultData or ErrorData.

OnPluginStart()

virtual void plugify::ILanguageModule::OnPluginStart ( PluginHandle  plugin )

pure virtual

Handle plugin start event.

Parameters

plugin

Handle to the started plugin.

OnPluginUpdate()

virtual void plugify::ILanguageModule::OnPluginUpdate ( PluginHandle  plugin, DateTime  dt  )

pure virtual

Handle plugin update event.

Parameters

plugin	Handle to the started plugin.
dt	The time delta since the last update.

OnUpdate()

virtual void plugify::ILanguageModule::OnUpdate ( DateTime  dt )

pure virtual

Handle actions to be performed on each frame.

Parameters

dt	The time delta since the last update.

---

The documentation for this class was generated from the following file:

• include/plugify/language_module.hpp