ISimplePipelinePack

Interface for simple pipeline packs.

Kind: Interface

Namespace: CrowdControl.Games.Packs

Public Member Functions

abstract virtual

Task

GetConnectionHost()

Gets the host string for the connection from the GUI.

abstract virtual

Task

GetConnectionLogin()

Gets the login string for the connection from the GUI.

abstract virtual

Task

GetConnectionPassword()

Gets the password string for the connection from the GUI.

abstract virtual

void

SetConnectionInfo(HostString host, string login, string password)

Sets the connection information for the pack.

abstract virtual

void

OnReady()

Handler for when the connection is ready.

abstract virtual

void

OnMessageParsed(IPipelineConnector sender, SimpleJSONResponse response, IConnectionContext context)

Handler for when a message is parsed.

abstract virtual

Task

CheckVersion()

Requests the version of the game from the connector.

Properties

AuthenticationType

AuthenticationMode

[get, ]

The authentication method used during login.

DigestAlgorithmType

AuthenticationHashMode

[get, ]

The authentication hash mode used during login.

AuthenticationStateType

AuthenticationState

[get, set]

The authentication state of the pack.

LoginPromptType

LoginPrompt

[get, ]

The type of authentication used for the connection.

LoginErrorHandlerType

LoginErrorHandler

[get, ]

Preferred fallback behavior for initial-connection errors.

SITimeSpan

ResponseTimeout

[get, ]

Timeout for responses from the game.

TextEncoding

Encoding

[get, ]

Text encoding used for the connection.

IGUIProvider

GUIProvider

[get, set]

Dialog provider for the connection dialog.

FunctionSet

RemoteFunctions

[get, ]

Describes any remote functions that are available to the client.

VersionNumber

RemoteVersion

[get, ]

The version of the game that the connector is connected to.

VersionNumber

RequireVersion

[get, ]

The version of the game that the connector requires.

VersionCheckBehavior

VersionCheckBehavior

[get, ]

The behavior to use when checking the version of the game.

Events

EventHandler<AuthenticationStateType>

AuthenticationStateChanged

Called when the authentication state changes.

Action<VersionNumber>

RemoteVersionReceived

Event that is raised when the remote version is received from the connector.