Photon.Bolt.GlobalEventListener Class Reference

Base class for all BoltCallbacks objects More...

Inheritance diagram for Photon.Bolt.GlobalEventListener:

Public Member Functions
virtual void	BoltShutdownBegin (AddCallback registerDoneCallback, UdpConnectionDisconnectReason disconnectReason)
	Callback triggered when the Bolt simulation is shutting down. More...
virtual void	BoltStartBegin ()
	Callback triggered before the Bolt simulation starts. More...
virtual void	BoltStartDone ()
	Callback triggered after the Bolt simulation starts. More...
virtual void	BoltStartFailed (UdpConnectionDisconnectReason disconnectReason)
	Callback triggered when Bolt was not able to initialize completely. More...
virtual void	ConnectAttempt (UdpEndPoint endpoint, IProtocolToken token)
	Callback triggered when trying to connect to a remote endpoint More...
virtual void	Connected (BoltConnection connection)
	Callback triggered when a client has become connected to this instance More...
virtual void	ConnectFailed (UdpEndPoint endpoint, IProtocolToken token)
	Callback triggered when a connection to remote server has failed More...
virtual void	ConnectRefused (UdpEndPoint endpoint, IProtocolToken token)
	Callback triggered when the connection to a remote server has been refused. More...
virtual void	ConnectRequest (UdpEndPoint endpoint, IProtocolToken token)
	Callback triggered when this instance receives an incoming client connection More...
virtual void	ControlOfEntityGained (BoltEntity entity)
	Callback triggered when this instance of bolt receieves control of a bolt entity More...
virtual void	ControlOfEntityLost (BoltEntity entity)
	Callback triggered when this instance of Bolt loses control of a Bolt entity More...
virtual void	Disconnected (BoltConnection connection)
	Callback triggered when disconnected from remote server More...
virtual void	EntityAttached (BoltEntity entity)
	Callback triggered when a new entity is attached to the bolt simulation More...
virtual void	EntityDetached (BoltEntity entity)
	Callback triggered when a new entity is detached from the bolt simulation More...
virtual void	EntityFrozen (BoltEntity entity)
	Callback triggered when a bolt entity is frozen. More...
virtual void	EntityReceived (BoltEntity entity)
	Callback triggered when a bolt entity is recieved from the network More...
virtual void	EntityThawed (BoltEntity entity)
	Callback triggered when a bolt entity is thawed. More...
virtual bool	PersistBetweenStartupAndShutdown ()
	Override this method and return true if you want the event listener to keep being attached to Bolt even when Bolt shuts down and starts again. More...
virtual void	SceneLoadLocalBegin (string scene, IProtocolToken token)
	Callback triggered before the new local scene is loaded. More...
virtual void	SceneLoadLocalDone (string scene, IProtocolToken token)
	Callback triggered after the new local scene has been completely loaded. More...
virtual void	SceneLoadRemoteDone (BoltConnection connection, IProtocolToken token)
	Callback triggered when a remote connection has completely loaded the current scene More...
virtual void	SessionConnected (UdpSession session, IProtocolToken token)
	Callback triggered when connecting to a session has successful. More...
virtual void	SessionConnectFailed (UdpSession session, IProtocolToken token, UdpSessionError errorReason)
	Callback triggered when connecting to a session has failed. More...
virtual void	SessionCreatedOrUpdated (UdpSession session)
	Callback triggered when the requested session creation was successful. More...
virtual void	SessionCreationFailed (UdpSession session, UdpSessionError errorReason)
	Callback triggered when the requested session creation has failed. More...
virtual void	SessionListUpdated (Map< System.Guid, UdpSession > sessionList)
	Callback triggered when the session list is updated. More...
virtual void	StreamDataAborted (BoltConnection connection, UdpChannelName channel, ulong streamID)
	Callback triggered when a binary stream data has been aborted. More...
virtual void	StreamDataProgress (BoltConnection connection, UdpChannelName channel, ulong streamID, float progress)
	Callback triggered when a new binary stream data is being transferred. More...
virtual void	StreamDataReceived (BoltConnection connection, UdpStreamData data)
	Callback triggered when binary stream data is received. More...
virtual void	StreamDataStarted (BoltConnection connection, UdpChannelName channel, ulong streamID)
	Callback triggered when a new binary stream data is being transferred. More...

Detailed Description

Base class for all BoltCallbacks objects

Example: Accepting an incoming remote connection.

public override void ConnectRequest(BoltConnection connection) {
  BoltNetwork.Accept(connection.remoteEndPoint);
}

Member Function Documentation

BoltShutdownBegin()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.BoltShutdownBegin ( AddCallback  registerDoneCallback, UdpConnectionDisconnectReason  disconnectReason  )

inlinevirtualinherited

Callback triggered when the Bolt simulation is shutting down.

Example: Logging a message in the Bolt console when the server has shut down unexpectedly.

public override void BoltShutdown(AddCallback registerDoneCallback, UdpConnectionDisconnectReason disconnectReason = UdpConnectionDisconnectReason.Disconnected) {
  BoltLog.Warn("Bolt is shutting down");
 
  registerDoneCallback(() =>
  {
      BoltLog.Warn("Bolt is down");
      SceneManager.LoadScene(0);
  });
}

BoltStartBegin()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.BoltStartBegin ( )

inlinevirtualinherited

Callback triggered before the Bolt simulation starts.

Example: Logging a message in the console when Bolt is starting.

public override void BoltStartBegin() {
    BoltLog.Info("Warning: Bolt is Starting...");
}

BoltStartDone()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.BoltStartDone ( )

inlinevirtualinherited

Callback triggered after the Bolt simulation starts.

Example: Logging a message in the console when Bolt is already started.

public override void BoltStartDone() {
  BoltLog.Info("Warning: Bolt started...");
}

BoltStartFailed()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.BoltStartFailed ( UdpConnectionDisconnectReason  disconnectReason )

inlinevirtualinherited

Callback triggered when Bolt was not able to initialize completely.

Example: Logging a message in the console when Bolt failed to start.

public override void BoltStartFailed(UdpConnectionDisconnectReason disconnectReason) {
  BoltLog.Info("Warning: Bolt failed to start. Reason: {0}", disconnectReason);
}

ConnectAttempt()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.ConnectAttempt ( UdpEndPoint  endpoint, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered when trying to connect to a remote endpoint

Parameters

endpoint	The remote server address
token	Token passed by the client when trying to connect to a server.

Example: Logging a message when initializing a connection to server.

public override void ConnectAttempt((UdpEndPoint endpoint) {
  BoltLog.Info(string.Format("To Remote Server At ({0}:{1})", endpoint.Address, endpoint.Port);
}

Connected()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.Connected ( BoltConnection  connection )

inlinevirtualinherited

Callback triggered when a client has become connected to this instance

Parameters

connection

Endpoint of the connected client

Example: Instantiating and configuring a player entity when a client connects to the server.

public override void Connected(BoltConnection connection) {
  BoltLog.Info("Accept Token {0} using Connect Token {1}", connection.AcceptToken, connection.ConnectToken);
 
  var player = BoltNetwork.Instantiate(BoltPrefabs.Player);
  player.transform.position = spawnPoint.transform.position;
 
  var initData = prototype.GetNewPlayer(GameLogic.PlayableClass.Mercenary);
  Configure(player, initData);
 
  player.AssignControl(connection);
}

ConnectFailed()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.ConnectFailed ( UdpEndPoint  endpoint, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered when a connection to remote server has failed

Parameters

endpoint	The remote address
token	Connect token sent by the client when trying to connect.

Example: Logging an error message when the remote connection has failed.

public override void ConnectFailed(UdpEndPoint endpoint, IProtocolToken token) {
  BoltLog.Info(string.Format("Connection To ({0}:{1}) has failed", endpoint.Address.ToString(), endpoint.ToString()));
}

ConnectRefused()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.ConnectRefused ( UdpEndPoint  endpoint, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered when the connection to a remote server has been refused.

Parameters

endpoint	The remote server endpoint
token	Data token sent by the refusing server

Example: Logging an error message when the remote connection has been refused using an error message token from the server.

public override void ConnectRefused(UdpEndPoint endpoint, IProtocolToken token) {
  ServerMessage.message = (ServerMessage)token;
  BoltLog.Info(string.Format("Connection To ({0}:{1}) has been refused. Reason was {3}", 
    endpoint.Address.ToString(), endpoint.ToString(), serverMessage.errorDescription));
}

ConnectRequest()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.ConnectRequest ( UdpEndPoint  endpoint, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered when this instance receives an incoming client connection

Parameters

endpoint	The incoming client endpoint
token	A data token sent from the incoming client

Example: Accepting an incoming connection with user credentials in the data token.

public override void ConnectRequest(UdpEndPoint endpoint, IProtocolToken token) {
  UserCredentials creds = (UserCredentials)token);
  if(Authenticate(creds.username, creds.password)) {
    BoltNetwork.Accept(connection.remoteEndPoint);
  }
}

ControlOfEntityGained()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.ControlOfEntityGained ( BoltEntity  entity )

inlinevirtualinherited

Callback triggered when this instance of bolt receieves control of a bolt entity

Parameters

entity

The controlled entity

Example: Setting up the game minimap and other components to use a specific entity as the player's controlled entity.

public override void ControlOfEntityGained(BoltEntity entity) {
  GameInput.instance.SetControlledEntity(entity);
  MiniMap.instance.SetControlledEntity(entity);
}

ControlOfEntityLost()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.ControlOfEntityLost ( BoltEntity  entity )

inlinevirtualinherited

Callback triggered when this instance of Bolt loses control of a Bolt entity

Parameters

entity

The controlled entity

Example: Setting up game components to no longer control an entity.

public override void ControlOfEntityLost(BoltEntity entity) {
  BoltLog.Info("Control lost with Token {0}", entity.ControlLostToken);
  GameInput.instance.RemoveControlledEntity(entity);
  MiniMap.instance.RemoveControlledEntity(entity);
}

Disconnected()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.Disconnected ( BoltConnection  connection )

inlinevirtualinherited

Callback triggered when disconnected from remote server

Parameters

connection

The remote server endpoint

Example: Logging a disconnect message and returning to the main menu scene.

public override void Disconnected(BoltConnection connection) {
  BoltLog.Info("Disconnected with Token {0}", connection.DisconnectToken);
  BoltLog.Info("Returning to main menu...");
  Application.LoadLevel("MainMenu");
}

EntityAttached()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.EntityAttached ( BoltEntity  entity )

inlinevirtualinherited

Callback triggered when a new entity is attached to the bolt simulation

Parameters

entity

The attached entity

Example: Setting up the game minimap to show a newly attached entity.

public override void EntityAttached(BoltEntity entity) {
  MiniMap.instance.SetKnownEntity(entity);
}

EntityDetached()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.EntityDetached ( BoltEntity  entity )

inlinevirtualinherited

Callback triggered when a new entity is detached from the bolt simulation

Parameters

entity

The detached entity

Example: Removing the newly detached entity from the game minimap.

public override void EntityDetached(BoltEntity entity) {
  MiniMap.instance.RemoveKnownEntity(entity);
}

EntityFrozen()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.EntityFrozen ( BoltEntity  entity )

inlinevirtualinherited

Callback triggered when a bolt entity is frozen.

Parameters

entity

The recieved bolt entity

Example: Loggging connections from remote players in the client bolt console

public override void EntityFrozen(BoltEntity entity) {
  string name = entity.GetState<PlayerState>().Name; 
  BoltLog.Info(string.Format("{0} Has been frozen", name));
}

EntityReceived()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.EntityReceived ( BoltEntity  entity )

inlinevirtualinherited

Callback triggered when a bolt entity is recieved from the network

Parameters

entity

The recieved bolt entity

Example: Loggging connections from remote players in the client bolt console

public override void EntityReceived(BoltEntity entity) {
  string name = entity.GetState<PlayerState>().Name; 
  BoltLog.Info(string.Format("{0} Has Connected", name));
}

EntityThawed()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.EntityThawed ( BoltEntity  entity )

inlinevirtualinherited

Callback triggered when a bolt entity is thawed.

Parameters

entity

The recieved bolt entity

Example: Loggging connections from remote players in the client bolt console

public override void EntityThawed(BoltEntity entity) {
  string name = entity.GetState<PlayerState>().Name; 
  BoltLog.Info(string.Format("{0} Has been thawed", name));
}

PersistBetweenStartupAndShutdown()

virtual bool Photon.Bolt.Internal.GlobalEventListenerBase.PersistBetweenStartupAndShutdown ( )

inlinevirtualinherited

Override this method and return true if you want the event listener to keep being attached to Bolt even when Bolt shuts down and starts again.

Returns

True/False

Example: Configuring the persistence behaviour to keep this listener alive between startup and shutdown.

public override bool PersistBetweenStartupAndShutdown() {
  return true;
}

SceneLoadLocalBegin()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SceneLoadLocalBegin ( string  scene, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered before the new local scene is loaded.

Parameters

scene	Name of scene being loaded
token	Token passed by the Server when loading the new scene.

Example: Showing a splash screen when clients are loading the game scene.

public override void SceneLoadLocalBegin(string scene, IProtocolToken token) {
  if(BoltNetwork.isClient && map.Equals(""GameScene"") {
    SplashScreen.Show(SplashScreens.GameLoad);
  }
}

SceneLoadLocalDone()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SceneLoadLocalDone ( string  scene, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered after the new local scene has been completely loaded.

Parameters

scene	Name of scene that has loaded
token	Token passed by the Server when loading the new scene.

Example: Hiding a splash screen that was shown during loading.

public override void SceneLoadLocalDone(string scene, IProtocolToken token) {
  if(BoltNetwork.isClient && scene.Equals(""GameScene"") {
    SplashScreen.Hide();
  }
}

SceneLoadRemoteDone()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SceneLoadRemoteDone ( BoltConnection  connection, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered when a remote connection has completely loaded the current scene

Parameters

connection	The remote connection
token	Token passed by the Server when loading the new scene.

Example: Instantiating and configuring a player entity on the server and then assigning control to the client.

public override void SceneLoadRemoteDone(BoltConnection connection, IProtocolToken token) {
  var player = BoltNetwork.Instantiate(BoltPrefabs.Player);
  player.transform.position = spawnPoint.transform.position;
 
  var initData = prototype.GetNewPlayer(GameLogic.PlayableClass.Mercenary);
  Configure(player, initData);
 
  player.AssignControl(connection);
}

SessionConnected()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SessionConnected ( UdpSession  session, IProtocolToken  token  )

inlinevirtualinherited

Callback triggered when connecting to a session has successful.

Parameters

session	The session the client was trying to connect to
token	Connection token

Example: Loggging

public override void SessionConnected(UdpSession session, IProtocolToken token)
{
  BoltLog.Error("Success to connect to session {0} with token {1}", session, token);
}

SessionConnectFailed()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SessionConnectFailed ( UdpSession  session, IProtocolToken  token, UdpSessionError  errorReason  )

inlinevirtualinherited

Callback triggered when connecting to a session has failed.

Parameters

session	The session the client was trying to connect to
token	Connection token
errorReason	Reason the operation has failed

Example: Loggging

public override void SessionConnectFailed(UdpSession session, IProtocolToken token, UdpSessionError errorReason)
{
  BoltLog.Error("Failed to connect to session {0} with token {1}", session, token);
}

SessionCreatedOrUpdated()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SessionCreatedOrUpdated ( UdpSession  session )

inlinevirtualinherited

Callback triggered when the requested session creation was successful.

Parameters

session

The created session

Example: Loggging

public override void SessionCreatedOrUpdated(UdpSession session)
{
  BoltLog.Info("UdpSession {0} of type {1} was created", session.HostName, session.Source);
}

SessionCreationFailed()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SessionCreationFailed ( UdpSession  session, UdpSessionError  errorReason  )

inlinevirtualinherited

Callback triggered when the requested session creation has failed.

Parameters

session	The failed session
errorReason	Reason the operation has failed

Example: Loggging

public override void SessionCreationFailed(UdpSession session, UdpSessionError errorReason)
{
  BoltLog.Info("UdpSession {0} of type {1} has failed to create", session.HostName, session.Source);
}

SessionListUpdated()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.SessionListUpdated ( Map< System.Guid, UdpSession >  sessionList )

inlinevirtualinherited

Callback triggered when the session list is updated.

Parameters

sessionList

The updated session list

Example: Loggging all sessions from the list.

public override void SessionListUpdated(Map<System.Guid, UdpSession> sessionList) {
  BoltLog.Info("Session list updated: {0} total sessions", sessionList.Count);
 
  foreach (var session in sessionList)
  {
    UdpSession udpSession = session.Value as UdpSession;
    BoltLog.Info("UdpSession {0} Source: {1}", udpSession.HostName, udpSession.Source);
  }
}

StreamDataAborted()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.StreamDataAborted ( BoltConnection  connection, UdpChannelName  channel, ulong  streamID  )

inlinevirtualinherited

Callback triggered when a binary stream data has been aborted.

Parameters

connection	The sender connection
channel	Stream Channel where the data was being sent
streamID	Stream Unique ID

Example: Receiving data from BoltConnection.

public override void StreamDataAborted(BoltConnection connnection, UdpChannelName channel, ulong streamID) { 
  BoltLog.Info("Stream {0} on channel {1} from connection {2} has been aborted.", streamID, channel, connection);
}

StreamDataProgress()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.StreamDataProgress ( BoltConnection  connection, UdpChannelName  channel, ulong  streamID, float  progress  )

inlinevirtualinherited

Callback triggered when a new binary stream data is being transferred.

Parameters

connection	The sender connection
channel	Stream Channel where the data is being sent
streamID	Stream Unique ID
progress	Stream transfer progress from 0 to 0.99

Example: Receiving data from BoltConnection.

public override void StreamDataProgress(BoltConnection connnection, UdpChannelName channel, ulong streamID, float progress) { 
  BoltLog.Info("Connection {0} is transfering data on channel {1} :: Transfer {2} on {3}%...", connection, channel, streamID, progress * 100);
}

StreamDataReceived()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.StreamDataReceived ( BoltConnection  connection, UdpStreamData  data  )

inlinevirtualinherited

Callback triggered when binary stream data is received.

Parameters

connection	The sender connection
data	The binary stream data

Example: Receiving a custom player icon.

public override void StreamDataReceived(BoltConnection connnection, UdpStreamData data) { 
  Texture2D icon = new Texture2D(4, 4);
  icon.LoadImage(data.Data);
 
  PlayerData playerData = (PlayerData)connection.userToken;
  playerData.SetIcon(icon);
}

StreamDataStarted()

virtual void Photon.Bolt.Internal.GlobalEventListenerBase.StreamDataStarted ( BoltConnection  connection, UdpChannelName  channel, ulong  streamID  )

inlinevirtualinherited

Callback triggered when a new binary stream data is being transferred.

Parameters

connection	The sender connection
channel	Stream Channel where the data will be sent
streamID	Stream Unique ID

Example: Receiving data from BoltConnection.

public override void StreamDataStarted(BoltConnection connnection, UdpChannelName channel, ulong streamID) { 
  BoltLog.Info("Connection {0} is transfering data on channel {1}...", connection, channel);
}