Photon.Hive.Plugin.ErrorPlugin Class Reference

Special plugin that causes most callbacks to fail. More...

Inheritance diagram for Photon.Hive.Plugin.ErrorPlugin:

Public Member Functions
	ErrorPlugin (string msg)
void	BeforeCloseGame (IBeforeCloseGameCallInfo info)
	Calls info.Continue More...
void	BeforeJoin (IBeforeJoinGameCallInfo info)
	Calls info.Fail More...
void	BeforeSetProperties (IBeforeSetPropertiesCallInfo info)
	Calls info.Fail More...
void	OnCloseGame (ICloseGameCallInfo info)
	Calls info.Continue More...
void	OnCreateGame (ICreateGameCallInfo info)
	Calls info.Fail More...
void	OnJoin (IJoinGameCallInfo info)
	Calls info.Fail More...
void	OnLeave (ILeaveGameCallInfo info)
	Calls info.Continue More...
void	OnRaiseEvent (IRaiseEventCallInfo info)
	Calls info.Fail More...
void	OnSetProperties (ISetPropertiesCallInfo info)
	Calls info.Fail More...
bool	OnUnknownType (Type type, ref object value)
	Does nothing. More...
void	ReportError (short errorCode, Exception e, object state=null)
	Does nothing. More...
bool	SetupInstance (IPluginHost host, Dictionary< string, string > config)
	Does nothing. More...
bool	SetupInstance (IPluginHost host, Dictionary< string, string > config, out string errorMessage)
	Does nothing. Only sets "errorMessage" to empty string. Does not set plugin host, nor initiliaze plugin using configuration. More...

Properties
string	Name [get]
string	Version [get]
bool	IsPersistent [get]
bool	UseStrictMode [get]
string	Message [get]
Properties inherited from Photon.Hive.Plugin.IGamePlugin
string	Name [get]
	Name of the plugin. Default is not allowed. This should be the name used when requesting the plugin from the client in CreateGame operation. This will be returned to the client in the CreateGame operation response. More...
string	Version [get]
	Version of the plugin. This will be returned to the client in the CreateGame operation response. More...
bool	IsPersistent [get]
	Flag used with webhooks plugin to indicate whether or not rooms should be persisted between connections. If true, SerializedGameState should be sent to web service before removing the room from memory. Also it could be loaded in OnCreateGame or BeforeJoin. More...

Detailed Description

Special plugin that causes most callbacks to fail.

Constructor & Destructor Documentation

ErrorPlugin()

Photon.Hive.Plugin.ErrorPlugin.ErrorPlugin ( string  msg )

inline

Member Function Documentation

BeforeCloseGame()

void Photon.Hive.Plugin.ErrorPlugin.BeforeCloseGame ( IBeforeCloseGameCallInfo  info )

inline

Calls info.Continue

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

BeforeJoin()

void Photon.Hive.Plugin.ErrorPlugin.BeforeJoin ( IBeforeJoinGameCallInfo  info )

inline

Calls info.Fail

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

BeforeSetProperties()

void Photon.Hive.Plugin.ErrorPlugin.BeforeSetProperties ( IBeforeSetPropertiesCallInfo  info )

inline

Calls info.Fail

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

OnCloseGame()

void Photon.Hive.Plugin.ErrorPlugin.OnCloseGame ( ICloseGameCallInfo  info )

inline

Calls info.Continue

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

OnCreateGame()

void Photon.Hive.Plugin.ErrorPlugin.OnCreateGame ( ICreateGameCallInfo  info )

inline

Calls info.Fail

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

OnJoin()

void Photon.Hive.Plugin.ErrorPlugin.OnJoin ( IJoinGameCallInfo  info )

inline

Calls info.Fail

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

OnLeave()

void Photon.Hive.Plugin.ErrorPlugin.OnLeave ( ILeaveGameCallInfo  info )

inline

Calls info.Continue

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

OnRaiseEvent()

void Photon.Hive.Plugin.ErrorPlugin.OnRaiseEvent ( IRaiseEventCallInfo  info )

inline

Calls info.Fail

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

OnSetProperties()

void Photon.Hive.Plugin.ErrorPlugin.OnSetProperties ( ISetPropertiesCallInfo  info )

inline

Calls info.Fail

Parameters

info

Implements Photon.Hive.Plugin.IGamePlugin.

OnUnknownType()

bool Photon.Hive.Plugin.ErrorPlugin.OnUnknownType ( Type  type, ref object  value  )

inline

Does nothing.

Parameters

type
value

Returns

False.

Implements Photon.Hive.Plugin.IGamePlugin.

ReportError()

void Photon.Hive.Plugin.ErrorPlugin.ReportError ( short  errorCode, Exception  e, object  state = null  )

inline

Does nothing.

Parameters

errorCode
e
state

Implements Photon.Hive.Plugin.IGamePlugin.

SetupInstance() [1/2]

bool Photon.Hive.Plugin.ErrorPlugin.SetupInstance ( IPluginHost  host, Dictionary< string, string >  config  )

inline

Does nothing.

Parameters

host
config

Returns

true.

SetupInstance() [2/2]

bool Photon.Hive.Plugin.ErrorPlugin.SetupInstance ( IPluginHost  host, Dictionary< string, string >  config, out string  errorMessage  )

inline

Does nothing. Only sets "errorMessage" to empty string. Does not set plugin host, nor initiliaze plugin using configuration.

Parameters

host
config
errorMessage

Returns

true

Implements Photon.Hive.Plugin.IGamePlugin.

Property Documentation

IsPersistent

bool Photon.Hive.Plugin.ErrorPlugin.IsPersistent

get

Message

string Photon.Hive.Plugin.ErrorPlugin.Message

get

Name

string Photon.Hive.Plugin.ErrorPlugin.Name

get

UseStrictMode

bool Photon.Hive.Plugin.ErrorPlugin.UseStrictMode

get

Version

string Photon.Hive.Plugin.ErrorPlugin.Version

get