plugify::ILanguageModule Class Reference

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

#include <language_module.hpp>

Public Member Functions
virtual Result< InitData >	Initialize (const Provider &provider, const Extension &module)=0
	Initialize the language module.
virtual void	Shutdown ()=0
	Shutdown the language module.
virtual void	OnUpdate (std::chrono::milliseconds deltaTime)=0
	Handle actions to be performed on each frame.
virtual Result< LoadData >	OnPluginLoad (const Extension &plugin)=0
	Handle plugin load event.
virtual void	OnPluginStart (const Extension &plugin)=0
	Handle plugin start event.
virtual void	OnPluginUpdate (const Extension &plugin, std::chrono::milliseconds deltaTime)=0
	Handle plugin update event.
virtual void	OnPluginEnd (const Extension &plugin)=0
	Handle plugin end event.
virtual void	OnMethodExport (const Extension &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 45 of file language_module.hpp.

Member Function Documentation

Initialize()

virtual Result< InitData > plugify::ILanguageModule::Initialize ( const Provider &  provider, const Extension &  module  )

pure virtual

Initialize the language module.

Parameters

provider	Weak ptr to the Plugify provider.
module	Ref to the language module being initialized.

Returns

Result of the initialization, either InitResultData or string.

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 ( const Extension &  plugin )

pure virtual

Handle method export event.

Parameters

plugin

Ref to the plugin exporting a method.

OnPluginEnd()

virtual void plugify::ILanguageModule::OnPluginEnd ( const Extension &  plugin )

pure virtual

Handle plugin end event.

Parameters

plugin

Ref to the ended plugin.

OnPluginLoad()

virtual Result< LoadData > plugify::ILanguageModule::OnPluginLoad ( const Extension &  plugin )

pure virtual

Handle plugin load event.

Parameters

plugin

Ref to the loaded plugin.

Returns

Result of the load event, either LoadResultData or string.

OnPluginStart()

virtual void plugify::ILanguageModule::OnPluginStart ( const Extension &  plugin )

pure virtual

Handle plugin start event.

Parameters

plugin

Ref to the started plugin.

OnPluginUpdate()

virtual void plugify::ILanguageModule::OnPluginUpdate ( const Extension &  plugin, std::chrono::milliseconds  deltaTime  )

pure virtual

Handle plugin update event.

Parameters

plugin	Ref to the started plugin.
deltaTime	The time delta since the last update.

OnUpdate()

virtual void plugify::ILanguageModule::OnUpdate ( std::chrono::milliseconds  deltaTime )

pure virtual

Handle actions to be performed on each frame.

Parameters

deltaTime

The time delta since the last update.

---

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

• include/plugify/language_module.hpp