IEffectPack

Interface for effect packs.

Kind: Interface

Namespace: CrowdControl.Games

Inheritance: IDisposable

Public Member Functions

abstract virtual

void

ReportCapabilities()

Reports the capabilities of the connector to the Crowd Control service.

abstract virtual

PrecheckResult

Precheck(string out message)

Checks if the effect pack is ready to process requests.

abstract virtual

void

ProcessRequest(IEffectPackProcessable request)

Processes a request for an effect/metadata/etc.

abstract virtual

bool

StopAllEffects()

Stops all effects in the effect pack.

abstract virtual

Task

InterpolateText(string message)

Sends the specified text to be displayed in the game.

abstract virtual

Task

GetPackState()

Serializes the effect pack to a JSON object.

abstract virtual

Task

SetPackState(JObject packState)

Deserializes the effect pack state from a JSON object.

Properties

IEffectCallbacks

Callbacks

[get, set]

The callback handler to be used for the effect pack.

Game

Game

[get, ]

The game that this effect pack is associated with.

IGameConnector

GameConnector

[get, set]

The ConnectorLib game connector to be used by this effect pack.

List>

MenuActions

[get, ]

The list of extra menu actions to be presented to the player.

UISettings

UISettings

[get, ]

The ccpak UI settings for the effect pack.

EffectList

Effects

[get, ]

The list of effects available in this effect pack.

EffectList

ConnectorEffects

[get, ]

The list of effects available as a basic connector function.

IEnumerable

SupportedEffects

[get, ]

The list of effects that are supported by the connector.

IEnumerable

UnsupportedEffects

[get, ]

The list of effects that are not supported by the connector.

SITimeSpan

GlobalMinimumDelay

[get, set]

The minimum delay between effects in the effect pack.

PackStatus

PackStatus

[get, ]

The current state of the effect pack.

GameState

GameState

[get, ]

The current state of the game.

IReadOnlyDictionary

MetadataDefaults

[get, ]

Default metadata values for the game.

SessionID

SessionID

[get, set]

The session ID for the current game session.

Events

EventHandler<PackStatus>

PackStateChanged

Handles a change in the effect pack state.

Action<IEnumerable<KeyValuePair<string, object>>>

MetadataChanged

Called when the game metadata changes.

EventHandler<GameState>

GameStateChanged

Handles a change in the game state.