Quantum 3 3.1.0

Public Attributes | Static Public Attributes | List of all members
Photon.Realtime.RaiseEventArgs Struct Reference

Aggregates several less-often used args 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...
 
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...
 
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...
 

Static Public Attributes

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

Detailed Description

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

Member Data Documentation

◆ Default

readonly RaiseEventArgs Photon.Realtime.RaiseEventArgs.Default = new RaiseEventArgs()
static

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

◆ CachingOption

EventCaching Photon.Realtime.RaiseEventArgs.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 args except SequenceChannel get ignored.

◆ InterestGroup

byte Photon.Realtime.RaiseEventArgs.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.

◆ TargetActors

int [] Photon.Realtime.RaiseEventArgs.TargetActors

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

◆ Receivers

ReceiverGroup Photon.Realtime.RaiseEventArgs.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.