Photon Server API

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

The set properties operation. More...

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

Public Member Functions

 SetPropertiesRequest (IRpcProtocol protocol, OperationRequest operationRequest)
 Initializes a new instance of the SetPropertiesRequest class. More...
 
 SetPropertiesRequest (int actorNr, Hashtable properties, Hashtable expected, bool broadcast)
 
 SetPropertiesRequest ()
 Initializes a new instance of the SetPropertiesRequest class. More...
 
- 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 newGameProperties
 
int? MasterClientId
 
Actor SenderActor
 
Actor TargetActor
 
IEnumerable< ActorPublishTo
 
string[] ExpectedUsers
 

Properties

int ActorNumber [get, set]
 Gets or sets ActorNumber. More...
 
bool Broadcast [get, set]
 Gets or sets a value indicating whether Broadcast. More...
 
Hashtable Properties [get, set]
 Gets or sets Properties. More...
 
Hashtable ExpectedValues [get, set]
 Expected values for properties, which we are going to set More...
 
object? internalWebFlags [get, set]
 
bool? HttpForward [get, set]
 
byte WebFlags [get, set]
 
byte OperationCode [get]
 
System.Collections.Generic.Dictionary< byte, object > Parameters [get]
 
bool UsingCAS [get]
 
bool UpdatingGameProperties [get]
 
- 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

The set properties operation.

Constructor & Destructor Documentation

◆ SetPropertiesRequest() [1/3]

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

Initializes a new instance of the SetPropertiesRequest class.

Parameters
protocolThe protocol.
operationRequestOperation request containing the operation parameters.

◆ SetPropertiesRequest() [2/3]

Photon.Hive.Operations.SetPropertiesRequest.SetPropertiesRequest ( int  actorNr,
Hashtable  properties,
Hashtable  expected,
bool  broadcast 
)
inline

◆ SetPropertiesRequest() [3/3]

Photon.Hive.Operations.SetPropertiesRequest.SetPropertiesRequest ( )
inline

Initializes a new instance of the SetPropertiesRequest class.

Member Data Documentation

◆ ExpectedUsers

string [] Photon.Hive.Operations.SetPropertiesRequest.ExpectedUsers

◆ MasterClientId

int? Photon.Hive.Operations.SetPropertiesRequest.MasterClientId

◆ newGameProperties

Hashtable Photon.Hive.Operations.SetPropertiesRequest.newGameProperties

◆ newIsOpen

bool? Photon.Hive.Operations.SetPropertiesRequest.newIsOpen

◆ newIsVisible

bool? Photon.Hive.Operations.SetPropertiesRequest.newIsVisible

◆ newLobbyProperties

object [] Photon.Hive.Operations.SetPropertiesRequest.newLobbyProperties

◆ newMaxPlayer

byte? Photon.Hive.Operations.SetPropertiesRequest.newMaxPlayer

◆ PublishTo

IEnumerable<Actor> Photon.Hive.Operations.SetPropertiesRequest.PublishTo

◆ SenderActor

Actor Photon.Hive.Operations.SetPropertiesRequest.SenderActor

◆ TargetActor

Actor Photon.Hive.Operations.SetPropertiesRequest.TargetActor

Property Documentation

◆ ActorNumber

int Photon.Hive.Operations.SetPropertiesRequest.ActorNumber
getset

Gets or sets ActorNumber.

◆ Broadcast

bool Photon.Hive.Operations.SetPropertiesRequest.Broadcast
getset

Gets or sets a value indicating whether Broadcast.

◆ ExpectedValues

Hashtable Photon.Hive.Operations.SetPropertiesRequest.ExpectedValues
getset

Expected values for properties, which we are going to set

◆ HttpForward

bool? Photon.Hive.Operations.SetPropertiesRequest.HttpForward
getset

◆ internalWebFlags

object? Photon.Hive.Operations.SetPropertiesRequest.internalWebFlags
getset

◆ OperationCode

byte Photon.Hive.Operations.SetPropertiesRequest.OperationCode
get

◆ Parameters

System.Collections.Generic.Dictionary<byte, object> Photon.Hive.Operations.SetPropertiesRequest.Parameters
get

◆ Properties

Hashtable Photon.Hive.Operations.SetPropertiesRequest.Properties
getset

Gets or sets Properties.

◆ UpdatingGameProperties

bool Photon.Hive.Operations.SetPropertiesRequest.UpdatingGameProperties
get

◆ UsingCAS

bool Photon.Hive.Operations.SetPropertiesRequest.UsingCAS
get

◆ WebFlags

byte Photon.Hive.Operations.SetPropertiesRequest.WebFlags
getset