Photon Server API Documentation v5.0RC1

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.Hive.Plugin.ISetPropertiesRequest Photon.SocketServer.Rpc.DataContract Photon.Hive.Plugin.IOperationRequest

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

Hashtable newGameProperties
 
Actor SenderActor
 
Actor TargetActor
 
IEnumerable< ActorPublishTo
 
- Public Attributes inherited from Photon.SocketServer.Rpc.Operation
byte Code => this.OperationRequest.OperationCode
 
RequestMetaData RequestMetaData => this.OperationRequest?.RequestMetaData
 

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...
 
bool? HttpForward [get, set]
 
byte WebFlags [get, set]
 
byte OperationCode [get]
 
Dictionary< byte, object > Parameters [get]
 
bool UsingCAS [get]
 
bool UpdatingGameProperties [get]
 
WellKnownProperties wellKnownPropertiesCache [get]
 
byte? newMaxPlayer [get]
 
bool? newIsOpen [get]
 
bool? newIsVisible [get]
 
int? MasterClientId [get]
 
string[] ExpectedUsers [get]
 
object[] newLobbyProperties [get]
 
ValuesUpdateFlags ValuesUpdated [get, set]
 whether we updated any of property values during this call More...
 
bool UpdateMasterOnWelKnownsUpdate [get, set]
 whether wel known properties will be updated 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...
 
- Properties inherited from Photon.Hive.Plugin.ISetPropertiesRequest
int ActorNumber [get, set]
 Gets or sets ActorNumber. More...
 
bool Broadcast [get, set]
 Gets or sets a value indicating whether Broadcast. More...
 
bool HttpForward [get, set]
 Gets or sets HttpForward webflag indicating if GameProperties webhook should be sent. More...
 
Hashtable Properties [get, set]
 Gets or sets Properties. More...
 
Hashtable ExpectedValues [get, set]
 Gets or sets Properties. More...
 
- Properties inherited from Photon.Hive.Plugin.IOperationRequest
byte OperationCode [get]
 Unique reserved code per operation. More...
 
Dictionary< byte, object > Parameters [get]
 Operation request parameters combined as sent by client. More...
 
byte WebFlags [get, set]
 Request webflags optionnaly set by client to control webhooks behaviour. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
static long GetTimestamp ()
 
- 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...
 

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

◆ newGameProperties

Hashtable Photon.Hive.Operations.SetPropertiesRequest.newGameProperties

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

◆ ExpectedUsers

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

◆ 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

◆ MasterClientId

int? Photon.Hive.Operations.SetPropertiesRequest.MasterClientId
get

◆ newIsOpen

bool? Photon.Hive.Operations.SetPropertiesRequest.newIsOpen
get

◆ newIsVisible

bool? Photon.Hive.Operations.SetPropertiesRequest.newIsVisible
get

◆ newLobbyProperties

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

◆ newMaxPlayer

byte? Photon.Hive.Operations.SetPropertiesRequest.newMaxPlayer
get

◆ OperationCode

byte Photon.Hive.Operations.SetPropertiesRequest.OperationCode
get

◆ Parameters

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

◆ Properties

Hashtable Photon.Hive.Operations.SetPropertiesRequest.Properties
getset

Gets or sets Properties.

◆ UpdateMasterOnWelKnownsUpdate

bool Photon.Hive.Operations.SetPropertiesRequest.UpdateMasterOnWelKnownsUpdate
getset

whether wel known properties will be updated

◆ UpdatingGameProperties

bool Photon.Hive.Operations.SetPropertiesRequest.UpdatingGameProperties
get

◆ UsingCAS

bool Photon.Hive.Operations.SetPropertiesRequest.UsingCAS
get

◆ ValuesUpdated

ValuesUpdateFlags Photon.Hive.Operations.SetPropertiesRequest.ValuesUpdated
getset

whether we updated any of property values during this call

◆ WebFlags

byte Photon.Hive.Operations.SetPropertiesRequest.WebFlags
getset

◆ wellKnownPropertiesCache

WellKnownProperties Photon.Hive.Operations.SetPropertiesRequest.wellKnownPropertiesCache
get