Photon .NET Client API
Public Member Functions | Public Attributes | Properties | List of all members
ExitGames.Client.Photon.EventData Class Reference

Contains all components of a Photon Event. Event Parameters, like OperationRequests and OperationResults, consist of a Dictionary with byte-typed keys per value. More...

Public Member Functions

override string ToString ()
 ToString() override. More...
 
string ToStringFull ()
 Extensive output of the event content. More...
 

Public Attributes

byte Code
 The event code identifies the type of event. More...
 
Dictionary< byte, object > Parameters
 The Parameters of an event is a Dictionary<byte, object>. More...
 

Properties

object this[byte key] [get, set]
 Alternative access to the Parameters. More...
 

Detailed Description

Contains all components of a Photon Event. Event Parameters, like OperationRequests and OperationResults, consist of a Dictionary with byte-typed keys per value.

The indexer of this class provides access to the Parameters Dictionary.

The operation RaiseEvent allows you to provide custom event content. Defined in LoadBalancing, this CustomContent will be made the value of key ParameterCode.CustomEventContent.

Member Function Documentation

override string ExitGames.Client.Photon.EventData.ToString ( )
inline

ToString() override.

Returns
Short output of "Event" and it's Code.
string ExitGames.Client.Photon.EventData.ToStringFull ( )
inline

Extensive output of the event content.

Returns
To be used in debug situations only, as it returns a string for each value.

Member Data Documentation

byte ExitGames.Client.Photon.EventData.Code

The event code identifies the type of event.

Dictionary<byte, object> ExitGames.Client.Photon.EventData.Parameters

The Parameters of an event is a Dictionary<byte, object>.

Property Documentation

object ExitGames.Client.Photon.EventData.this[byte key]
getset

Alternative access to the Parameters.

Parameters
keyThe key byte-code of a event value.
Returns
The Parameters value, or null if the key does not exist in Parameters.

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