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, ModuleRef module)=0
	Initialize the language module. More...
virtual void	Shutdown ()=0
	Shutdown the language module.
virtual LoadResult	OnPluginLoad (PluginRef plugin)=0
	Handle plugin load event. More...
virtual void	OnPluginStart (PluginRef plugin)=0
	Handle plugin start event. More...
virtual void	OnPluginEnd (PluginRef plugin)=0
	Handle plugin end event. More...
virtual void	OnMethodExport (PluginRef plugin)=0
	Handle method export event. More...
virtual bool	IsDebugBuild ()=0
	Handle actions to be performed on each game frame. More...

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 82 of file language_module.hpp.

Member Function Documentation

Initialize()

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

pure virtual

Initialize the language module.

Parameters

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

Returns

Result of the initialization, either InitResultData or ErrorData.

IsDebugBuild()

virtual bool plugify::ILanguageModule::IsDebugBuild ( )

pure virtual

Handle actions to be performed on each game frame.

This method is called once per game frame and allows the language module to perform periodic updates or processing required during the game loop.

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 ( PluginRef  plugin )

pure virtual

Handle method export event.

Parameters

plugin

Reference to the plugin exporting a method.

OnPluginEnd()

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

pure virtual

Handle plugin end event.

Parameters

plugin

Reference to the ended plugin.

OnPluginLoad()

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

pure virtual

Handle plugin load event.

Parameters

plugin

Reference to the loaded plugin.

Returns

Result of the load event, either LoadResultData or ErrorData.

OnPluginStart()

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

pure virtual

Handle plugin start event.

Parameters

plugin

Reference to the started plugin.

---

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

• include/plugify/language_module.hpp