Photon Server API Documentation v5.0RC1

Public Member Functions | Properties | List of all members
Photon.LoadBalancing.Operations.JoinRandomGameRequest Class Reference
Inheritance diagram for Photon.LoadBalancing.Operations.JoinRandomGameRequest:
Photon.SocketServer.Rpc.Operation Photon.SocketServer.Rpc.DataContract

Public Member Functions

 JoinRandomGameRequest (IRpcProtocol protocol, OperationRequest operationRequest)
 
 JoinRandomGameRequest ()
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
 Operation (IRpcProtocol protocol, OperationRequest request)
 Initializes a new instance of the Operation class. This contructor is used for incoming operations. More...
 
 Operation ()
 Initializes a new instance of the Operation class. This contructor is used for outgoing operations. More...
 
void OnComplete ()
 Updates photon counters for the measure execution time. Call OnStart first. More...
 
void OnStart ()
 Starts measuring the execution time. Call OnComplete to update photon counters. More...
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.DataContract
string GetErrorMessage ()
 Gets a message containing descriptive entries for each missing or invalid paramter. More...
 
Dictionary< byte, object > ToDictionary ()
 Converts all properties flagged with the DataMemberAttribute to a dictionary. More...
 

Properties

Hashtable GameProperties [get, set]
 
byte JoinRandomType [get, set]
 
string QueryData [get, set]
 
string LobbyName [get, set]
 
byte LobbyType [get, set]
 
string[] AddUsers [get, set]
 
virtual string GameId [get, set]
 Gets or sets the name of the game (room). More...
 
byte JoinMode [get, set]
 
bool CreateIfNotExists [get]
 
Hashtable Properties [get, set]
 GameProperties for game creation. If game has to be created GameProperties (key 248, used for filter) are replaced with these values. More...
 
- Properties inherited from Photon.SocketServer.Rpc.Operation
OperationRequest OperationRequest [get]
 Gets the underlying OperationRequest. More...
 
- Properties inherited from Photon.SocketServer.Rpc.DataContract
bool IsValid [get]
 Gets a value indicating whether all operation parameter are initialized. Call the GetErrorMessage method to get a detailed description for all missing parameters. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
static long GetTimestamp ()
 
- Public Attributes inherited from Photon.SocketServer.Rpc.Operation
byte Code => this.OperationRequest.OperationCode
 
RequestMetaData RequestMetaData => this.OperationRequest?.RequestMetaData
 
- Protected Member Functions inherited from Photon.SocketServer.Rpc.Operation
virtual void OnCompleted ()
 this method is called from inside of OnComplete() if startTime is not null More...
 
virtual void OnStarted ()
 called from inside of OnStart just after startTime is set More...
 
- Protected Member Functions inherited from Photon.SocketServer.Rpc.DataContract
 DataContract (IRpcProtocol protocol, IDictionary< byte, object > dataMembers)
 Initializes a new instance of the DataContract class. The params dictionary is mapped to properties flagged with the DataMemberAttribute. Check the IsValid property after creation to determine if all paramters have been initialized correctly. More...
 
 DataContract ()
 Initializes a new instance of the DataContract class. More...
 
- Protected Attributes inherited from Photon.SocketServer.Rpc.DataContract
string errorMessage
 The error message. More...
 
bool isValid
 The is valid. More...
 

Constructor & Destructor Documentation

◆ JoinRandomGameRequest() [1/2]

Photon.LoadBalancing.Operations.JoinRandomGameRequest.JoinRandomGameRequest ( IRpcProtocol  protocol,
OperationRequest  operationRequest 
)
inline

◆ JoinRandomGameRequest() [2/2]

Photon.LoadBalancing.Operations.JoinRandomGameRequest.JoinRandomGameRequest ( )
inline

Property Documentation

◆ AddUsers

string [] Photon.LoadBalancing.Operations.JoinRandomGameRequest.AddUsers
getset

◆ CreateIfNotExists

bool Photon.LoadBalancing.Operations.JoinRandomGameRequest.CreateIfNotExists
get

◆ GameId

virtual string Photon.LoadBalancing.Operations.JoinRandomGameRequest.GameId
getset

Gets or sets the name of the game (room).

◆ GameProperties

Hashtable Photon.LoadBalancing.Operations.JoinRandomGameRequest.GameProperties
getset

◆ JoinMode

byte Photon.LoadBalancing.Operations.JoinRandomGameRequest.JoinMode
getset

◆ JoinRandomType

byte Photon.LoadBalancing.Operations.JoinRandomGameRequest.JoinRandomType
getset

◆ LobbyName

string Photon.LoadBalancing.Operations.JoinRandomGameRequest.LobbyName
getset

◆ LobbyType

byte Photon.LoadBalancing.Operations.JoinRandomGameRequest.LobbyType
getset

◆ Properties

Hashtable Photon.LoadBalancing.Operations.JoinRandomGameRequest.Properties
getset

GameProperties for game creation. If game has to be created GameProperties (key 248, used for filter) are replaced with these values.

◆ QueryData

string Photon.LoadBalancing.Operations.JoinRandomGameRequest.QueryData
getset