Photon Server API
Public Member Functions | Public Attributes | Properties | List of all members
Photon.Hive.Operations.JoinGameRequest Class Reference

This class implements the Join operation. More...

Inheritance diagram for Photon.Hive.Operations.JoinGameRequest:
Photon.SocketServer.Rpc.Operation Photon.SocketServer.Rpc.DataContract Photon.Hive.Operations.CreateGameRequest

Public Member Functions

 JoinGameRequest (IRpcProtocol protocol, OperationRequest operationRequest)
 Initializes a new instance of the JoinGameRequest class. More...
 
void SetupRequest ()
 
 JoinGameRequest ()
 Initializes a new instance of the JoinGameRequest class. More...
 
Dictionary< string, object > GetCreateGameSettings (HiveGame game)
 
string GetNickname ()
 
void OnJoinFailed (ErrorCode reason, string msg)
 
- 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...
 

Public Attributes

byte newMaxPlayer
 
bool newIsOpen
 
bool newIsVisible
 
object[] newLobbyProperties
 
Hashtable properties
 

Properties

Hashtable ActorProperties [get, set]
 Gets or sets custom actor properties. More...
 
bool BroadcastActorProperties [get, set]
 Gets or sets a value indicating whether the actor properties should be included in the JoinEvent event which will be sent to all clients currently in the room. More...
 
virtual string GameId [get, set]
 Gets or sets the name of the game (room). More...
 
Hashtable GameProperties [get, set]
 Gets or sets custom game properties. More...
 
bool DeleteCacheOnLeave [get, set]
 Gets or sets a value indicating whether cached events are automaticly deleted for actors which are leaving a room. More...
 
bool SuppressRoomEvents [get, set]
 Gets or sets a value indicating if common room events (Join, Leave) will be suppressed. More...
 
int ActorNr [get, set]
 Actor number, which will be used for rejoin More...
 
int EmptyRoomLiveTime [get, set]
 Gets or sets a value indicating how long the room instance will be keeped alive in the room cache after all peers have left the room. More...
 
int PlayerTTL [get, set]
 The time a player the room waits to allow a player to rejoin after a disconnect. If player should be allowed to return any time set the value less than 0. More...
 
bool CheckUserOnJoin [get, set]
 Set true to restrict useres to connect only once. Default is not to check. More...
 
int CacheSlice [get, set]
 The lowest slice of cached events the actor expects to recieve. More...
 
string LobbyName [get, set]
 
byte LobbyType [get, set]
 
string[] Plugins [get, set]
 Informs the server of the expected plugin setup. More...
 
byte WebFlags [get, set]
 
string[] AddUsers [get, set]
 
bool PublishUserId [get, set]
 
bool ForceRejoin [get, set]
 
byte JoinMode [get, set]
 
bool CreateIfNotExists [get]
 
byte OperationCode [get]
 
Dictionary< byte, object > Parameters [get]
 
bool IsRejoining [get]
 
ErrorCode FailureReason [get, protected set]
 
string FailureMessage [get, protected set]
 
- Properties inherited from Photon.SocketServer.Rpc.Operation
OperationRequest OperationRequest [get]
 Gets the 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

- 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...
 

Detailed Description

This class implements the Join operation.

Constructor & Destructor Documentation

Photon.Hive.Operations.JoinGameRequest.JoinGameRequest ( IRpcProtocol  protocol,
OperationRequest  operationRequest 
)
inline

Initializes a new instance of the JoinGameRequest class.

Parameters
protocolThe protocol.
operationRequestOperation request containing the operation parameters.
Photon.Hive.Operations.JoinGameRequest.JoinGameRequest ( )
inline

Initializes a new instance of the JoinGameRequest class.

Member Function Documentation

Dictionary<string, object> Photon.Hive.Operations.JoinGameRequest.GetCreateGameSettings ( HiveGame  game)
inline
string Photon.Hive.Operations.JoinGameRequest.GetNickname ( )
inline
void Photon.Hive.Operations.JoinGameRequest.OnJoinFailed ( ErrorCode  reason,
string  msg 
)
inline
void Photon.Hive.Operations.JoinGameRequest.SetupRequest ( )
inline

Member Data Documentation

bool Photon.Hive.Operations.JoinGameRequest.newIsOpen
bool Photon.Hive.Operations.JoinGameRequest.newIsVisible
object [] Photon.Hive.Operations.JoinGameRequest.newLobbyProperties
byte Photon.Hive.Operations.JoinGameRequest.newMaxPlayer
Hashtable Photon.Hive.Operations.JoinGameRequest.properties

Property Documentation

int Photon.Hive.Operations.JoinGameRequest.ActorNr
getset

Actor number, which will be used for rejoin

Hashtable Photon.Hive.Operations.JoinGameRequest.ActorProperties
getset

Gets or sets custom actor properties.

string [] Photon.Hive.Operations.JoinGameRequest.AddUsers
getset
bool Photon.Hive.Operations.JoinGameRequest.BroadcastActorProperties
getset

Gets or sets a value indicating whether the actor properties should be included in the JoinEvent event which will be sent to all clients currently in the room.

int Photon.Hive.Operations.JoinGameRequest.CacheSlice
getset

The lowest slice of cached events the actor expects to recieve.

bool Photon.Hive.Operations.JoinGameRequest.CheckUserOnJoin
getset

Set true to restrict useres to connect only once. Default is not to check.

bool Photon.Hive.Operations.JoinGameRequest.CreateIfNotExists
get
bool Photon.Hive.Operations.JoinGameRequest.DeleteCacheOnLeave
getset

Gets or sets a value indicating whether cached events are automaticly deleted for actors which are leaving a room.

int Photon.Hive.Operations.JoinGameRequest.EmptyRoomLiveTime
getset

Gets or sets a value indicating how long the room instance will be keeped alive in the room cache after all peers have left the room.

This property will only be applied for the room creator.

string Photon.Hive.Operations.JoinGameRequest.FailureMessage
getprotected set
ErrorCode Photon.Hive.Operations.JoinGameRequest.FailureReason
getprotected set
bool Photon.Hive.Operations.JoinGameRequest.ForceRejoin
getset
virtual string Photon.Hive.Operations.JoinGameRequest.GameId
getset

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

Hashtable Photon.Hive.Operations.JoinGameRequest.GameProperties
getset

Gets or sets custom game properties.

Game properties will only be applied for the game creator.

bool Photon.Hive.Operations.JoinGameRequest.IsRejoining
get
byte Photon.Hive.Operations.JoinGameRequest.JoinMode
getset
string Photon.Hive.Operations.JoinGameRequest.LobbyName
getset
byte Photon.Hive.Operations.JoinGameRequest.LobbyType
getset
byte Photon.Hive.Operations.JoinGameRequest.OperationCode
get
Dictionary<byte, object> Photon.Hive.Operations.JoinGameRequest.Parameters
get
int Photon.Hive.Operations.JoinGameRequest.PlayerTTL
getset

The time a player the room waits to allow a player to rejoin after a disconnect. If player should be allowed to return any time set the value less than 0.

string [] Photon.Hive.Operations.JoinGameRequest.Plugins
getset

Informs the server of the expected plugin setup.

The operation will fail in case of a plugin missmatch returning error code PluginMismatch 32757(0x7FFF - 10). Setting string[]{} means the client expects no plugin to be setup. Note: for backwards compatibility null omits any check.

bool Photon.Hive.Operations.JoinGameRequest.PublishUserId
getset
bool Photon.Hive.Operations.JoinGameRequest.SuppressRoomEvents
getset

Gets or sets a value indicating if common room events (Join, Leave) will be suppressed.

This property will only be applied for the game creator.

byte Photon.Hive.Operations.JoinGameRequest.WebFlags
getset