Base interface of any engine plugin. More...

#include <DGLE.h>

Inheritance diagram for IPlugin:

Public Member Functions
virtual DGLE_RESULT DGLE_API	GetPluginInfo (TPluginInfo &stInfo)=0
	Returns structure with plugin description.

virtual DGLE_RESULT DGLE_API	GetPluginInterfaceName (char *pcName, uint &uiCharsCount)=0
	Returns the name of interface which plugin implements or empty string if it implements nothing.

Public Member Functions inherited from IDGLE_Base
virtual DGLE_RESULT DGLE_API	GetGUID (GUID &guid)=0
	Returns unique identifier of the last interface in the inheritance chain.

virtual DGLE_RESULT DGLE_API	ExecuteCommand (uint uiCmd, TVariant &stVar)=0
	Executes some command using its index or bitmask.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommand (const char *pcCommand, TVariant &stVar)=0
	Executes some text command and returns result as variant.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommandEx (const char pcCommand, char pcResult, uint &uiCharsCount)=0
	Executes some text command and returns result as string.

Detailed Description

Base interface of any engine plugin.

Member Function Documentation

virtual DGLE_RESULT DGLE_API GetPluginInfo ( TPluginInfo & stInfo )

pure virtual

Returns structure with plugin description.

Parameters

[out] stInfo Structure in which plugin description will be stored.

virtual DGLE_RESULT DGLE_API GetPluginInterfaceName	(	char *	pcName,
		uint &	uiCharsCount
	)

pure virtual

Returns the name of interface which plugin implements or empty string if it implements nothing.

Parameters

[out]	pcName	Pointer to allocated string.
[in,out]	uiCharsCount	Count of the chars in allocated string.

Note: If pcName is NULL then uiCharsCount will contain length of the text to allocate.