C# Class RaiseEventOptions

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

Show file Open project: daniel-cheng/stellar Class Usage Examples

Public Properties

Property	Type	Description
CachingOption	EventCaching
Default	RaiseEventOptions,
Encrypt	bool
ForwardToWebhook	bool
InterestGroup	byte
Receivers	ReceiverGroup
SequenceChannel	byte
TargetActors	int[]

Property Details

CachingOption public property

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.

public EventCaching CachingOption
return	EventCaching

Default public static property

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

public static RaiseEventOptions, Default
return	RaiseEventOptions,

Encrypt public property

Used along with CachingOption SliceSetIndex, SlicePurgeIndex or SlicePurgeUpToIndex if you want to set or purge a specific cache-slice.

public bool Encrypt
return	bool

ForwardToWebhook public property

Events can be forwarded to Webhooks, which can evaluate and use the events to follow the game's state.

public bool ForwardToWebhook
return	bool

InterestGroup public property

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.

public byte InterestGroup
return	byte

Receivers public property

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.

public ReceiverGroup Receivers
return	ReceiverGroup

SequenceChannel public property

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

public byte SequenceChannel
return	byte

TargetActors public property

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

public int[] TargetActors
return	int[]