Photon Unity Networking 2 2.30

Public Attributes | Static Public Attributes | List of all members
RaiseEventOptions Class Reference

Aggregates several less-often used options for operation RaiseEvent. See field descriptions for usage details. More...

Public Attributes

EventCaching CachingOption
 Defines if the server should simply send the event, put it in the cache or remove events that are like this one. More...
 
byte InterestGroup
 The number of the Interest Group to send this to. 0 goes to all users but to get 1 and up, clients must subscribe to the group first. More...
 
int[] TargetActors
 A list of Player.ActorNumbers to send this event to. You can implement events that just go to specific users this way. More...
 
ReceiverGroup Receivers
 Sends the event to All, MasterClient or Others (default). Be careful with MasterClient, as the client might disconnect before it got the event and it gets lost. More...
 
byte SequenceChannel
 Events are ordered per "channel". If you have events that are independent of others, they can go into another sequence or channel. More...
 
WebFlags Flags = WebFlags.Default
 Optional flags to be used in Photon client SDKs with Op RaiseEvent and Op SetProperties. More...
 

Static Public Attributes

static readonly RaiseEventOptions Default = new RaiseEventOptions()
 Default options: CachingOption: DoNotCache, InterestGroup: 0, targetActors: null, receivers: Others, sequenceChannel: 0. More...
 

Detailed Description

Aggregates several less-often used options for operation RaiseEvent. See field descriptions for usage details.

Member Data Documentation

◆ CachingOption

EventCaching CachingOption

Defines if the server should simply send the event, put it in the cache or remove events that are like this one.

When using option: SliceSetIndex, SlicePurgeIndex or SlicePurgeUpToIndex, set a CacheSliceIndex. All other options except SequenceChannel get ignored.

◆ Default

readonly RaiseEventOptions Default = new RaiseEventOptions()
static

Default options: CachingOption: DoNotCache, InterestGroup: 0, targetActors: null, receivers: Others, sequenceChannel: 0.

◆ Flags

WebFlags Flags = WebFlags.Default

Optional flags to be used in Photon client SDKs with Op RaiseEvent and Op SetProperties.

Introduced mainly for webhooks 1.2 to control behavior of forwarded HTTP requests.

◆ InterestGroup

byte InterestGroup

The number of the Interest Group to send this to. 0 goes to all users but to get 1 and up, clients must subscribe to the group first.

◆ Receivers

ReceiverGroup Receivers

Sends the event to All, MasterClient or Others (default). Be careful with MasterClient, as the client might disconnect before it got the event and it gets lost.

◆ SequenceChannel

byte SequenceChannel

Events are ordered per "channel". If you have events that are independent of others, they can go into another sequence or channel.

◆ TargetActors

int [] TargetActors

A list of Player.ActorNumbers to send this event to. You can implement events that just go to specific users this way.