Skip to content

EffectPack<TConnector> ​

Kind: Abstract class

Namespace: CrowdControl.Games

Inheritance: EffectPack → IDisposable → IEffectPack → IEffectPack → IEffectPack\<TConnector\>

Public Member Functions

IEnumerator

GetEnumerator()

Gets an enumerator that iterates through the collection of effect handler types for the effect pack.

bool

TryFind(EffectRequest request, IEffectHandler out handler)

Tries to find an effect handler for the specified request.

void

ReturnHandler(EffectRequest request)

Handles the return of an effect handler.

virtual override

Task

GetPackState()

virtual override

Task

SetPackState(JObject packState)

Properties

UserRecord

Player

[get, ]

The user object for the streamer.

TConnector

Connector

[get, set]

IGameConnector

GameConnector

[get, set]

SITimeSpan

StatusRefreshInterval

[get, set]

The time to wait between refreshing the status of the game connector.

bool

ProcessResponses

[get, set]

true if the effect pack should process responses from the Crowd Control service; otherwise, false.

IEnumerable

Handlers

[get, ]

The collection of effect handler types for the effect pack.

ConcurrentDictionary

TypeLookup

[get, ]

The collection of effect handler types for the effect pack, indexed by effect ID.

ConcurrentDictionary>

ReturnedInstances

[get, ]

The collection of effect handler instances that have been returned to the pool and are available for reuse.

ConcurrentDictionary

HandlerInstances

[get, ]

The collection of effect handler instances that are currently in use.

Events

EventHandler<TConnector>

ConnectorAttached

Handles the event when a connector is attached.

Action<TConnector>

ConnectorReady

Handles the event when the attached connector is connected and ready.