Photon Plugins API Documentation v5.0RC1

Public Member Functions | Protected Attributes | List of all members
Photon.Hive.Plugin.PluginFactoryBase Class Referenceabstract

Base abstract class of plugin factory pattern. More...

Inheritance diagram for Photon.Hive.Plugin.PluginFactoryBase:
Photon.Hive.Plugin.IPluginFactory2 Photon.Hive.Plugin.IPluginFactory

Public Member Functions

IGamePlugin Create (IPluginHost gameHost, string pluginName, Dictionary< string, string > config, out string errorMsg)
 Create and initialize a new plugin instance. More...
 
void SetFactoryHost (IFactoryHost fHost, FactoryParams factoryParams)
 
abstract IGamePlugin CreatePlugin (string pluginName)
 Returns instance of the plugin. More...
 

Protected Attributes

IFactoryHost factoryHost
 

Detailed Description

Base abstract class of plugin factory pattern.

Member Function Documentation

◆ Create()

IGamePlugin Photon.Hive.Plugin.PluginFactoryBase.Create ( IPluginHost  gameHost,
string  pluginName,
Dictionary< string, string >  config,
out string  errorMsg 
)
inline

Create and initialize a new plugin instance.

Parameters
gameHostThe game to host the plugin instance.
pluginNameThe plugin name as requested by client in Op CreateGame.
configThe plugin assembly key/value configuration entries.
errorMsgAn eventual error message to return in case something goes wrong.
Returns
The plugin instance or null.

Implements Photon.Hive.Plugin.IPluginFactory.

◆ CreatePlugin()

abstract IGamePlugin Photon.Hive.Plugin.PluginFactoryBase.CreatePlugin ( string  pluginName)
pure virtual

Returns instance of the plugin.

Parameters
pluginNameThe plugin name as requested by client in Op CreateGame.
Returns
The plugin instance or null.

◆ SetFactoryHost()

void Photon.Hive.Plugin.PluginFactoryBase.SetFactoryHost ( IFactoryHost  fHost,
FactoryParams  factoryParams 
)
inline

Member Data Documentation

◆ factoryHost

IFactoryHost Photon.Hive.Plugin.PluginFactoryBase.factoryHost
protected