Photon Server API Documentation v5.0RC1

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

The get properties request. More...

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

Public Member Functions

 GetPropertiesRequest (IRpcProtocol protocol, OperationRequest operationRequest)
 Initializes a new instance of the GetPropertiesRequest class. More...
 
 GetPropertiesRequest ()
 Initializes a new instance of the GetPropertiesRequest 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...
 

Properties

int[] ActorNumbers [get, set]
 Gets or sets the actor numbers for which to get the properties. More...
 
object[] ActorPropertyKeys [get, set]
 Gets or sets ActorPropertyKeys. More...
 
object[] GamePropertyKeys [get, set]
 Gets or sets GamePropertyKeys. More...
 
byte PropertyType [get, set]
 Gets or sets PropertyType. 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...
 

Detailed Description

The get properties request.

Constructor & Destructor Documentation

◆ GetPropertiesRequest() [1/2]

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

Initializes a new instance of the GetPropertiesRequest class.

Parameters
protocolThe protocol.
operationRequestOperation request containing the operation parameters.

◆ GetPropertiesRequest() [2/2]

Photon.Hive.Operations.GetPropertiesRequest.GetPropertiesRequest ( )
inline

Initializes a new instance of the GetPropertiesRequest class.

Property Documentation

◆ ActorNumbers

int [] Photon.Hive.Operations.GetPropertiesRequest.ActorNumbers
getset

Gets or sets the actor numbers for which to get the properties.

◆ ActorPropertyKeys

object [] Photon.Hive.Operations.GetPropertiesRequest.ActorPropertyKeys
getset

Gets or sets ActorPropertyKeys.

◆ GamePropertyKeys

object [] Photon.Hive.Operations.GetPropertiesRequest.GamePropertyKeys
getset

Gets or sets GamePropertyKeys.

◆ PropertyType

byte Photon.Hive.Operations.GetPropertiesRequest.PropertyType
getset

Gets or sets PropertyType.