Photon Plugins API Documentation
Properties | List of all members
Photon.Hive.Plugin.IRaiseEventRequest Interface Reference

Base interface of Op RaiseEvent request containing the parameters as sent by client. More...

Inheritance diagram for Photon.Hive.Plugin.IRaiseEventRequest:
Photon.Hive.Plugin.IOperationRequest

Properties

int[] Actors [get, set]
 Gets or sets the actors which should receive the event. If set to null or an empty array the event will be sent to all actors in the room. More...
 
byte Cache [get, set]
 Gets or sets a value indicating how to use the EventCache. More...
 
object Data [get, set]
 Gets or sets the hashtable containing the data to send. More...
 
byte EvCode [get, set]
 Gets or sets a byte containing the Code to send. More...
 
string GameId [get, set]
 Gets or sets the game id. More...
 
byte Group [get, set]
 Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event. More...
 
bool HttpForward [get, set]
 Gets or sets HttpForward webflag indicating whether GameEvent webhook should be sent. More...
 
byte ReceiverGroup [get, set]
 Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event. More...
 
int CacheSliceIndex [get, set]
 Cache slice index to be used when caching option requires it. 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...
 

Detailed Description

Base interface of Op RaiseEvent request containing the parameters as sent by client.

Property Documentation

int [] Photon.Hive.Plugin.IRaiseEventRequest.Actors
getset

Gets or sets the actors which should receive the event. If set to null or an empty array the event will be sent to all actors in the room.

Optional request parameter.

byte Photon.Hive.Plugin.IRaiseEventRequest.Cache
getset

Gets or sets a value indicating how to use the EventCache.

Optional request parameter. Ignored if the event is sent to individual actors (submitted Actors or Photon.Hive.Plugin.Operations.MasterClient).

int Photon.Hive.Plugin.IRaiseEventRequest.CacheSliceIndex
getset

Cache slice index to be used when caching option requires it.

object Photon.Hive.Plugin.IRaiseEventRequest.Data
getset

Gets or sets the hashtable containing the data to send.

Optional request parameter.

byte Photon.Hive.Plugin.IRaiseEventRequest.EvCode
getset

Gets or sets a byte containing the Code to send.

Optional request parameter.

string Photon.Hive.Plugin.IRaiseEventRequest.GameId
getset

Gets or sets the game id.

Optional request parameter.

byte Photon.Hive.Plugin.IRaiseEventRequest.Group
getset

Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event.

Optional request parameter. Ignored if Actors are set.

bool Photon.Hive.Plugin.IRaiseEventRequest.HttpForward
getset

Gets or sets HttpForward webflag indicating whether GameEvent webhook should be sent.

byte Photon.Hive.Plugin.IRaiseEventRequest.ReceiverGroup
getset

Gets or sets the Photon.Hive.Operations.ReceiverGroup for the event.

Optional request parameter. Ignored if Actors are set.