EffectPack.EffectState

A struct representing the running state of an effect.

Kind: Struct

Namespace: CrowdControl.Games

Public Member Functions

void

Deconstruct(bool? out success, string out message)

void

Deconstruct(bool? out success, ErrorMessage out message)

Public Attributes

Guid

Request

The original request to which this response pertains.

StandardErrors

MessageID

The ID of a standardized message.

bool?

Abnormal

true if the response is considered abnormal; otherwise, false.

ErrorSource

ErrorSource

The component that caused the error currently being reported.

Properties

StatusValue

Value

[get, set]

The status of the effect.

Union

Message

[get, ]

The message from the client, if any.

Task

WhenStarted

[get, ]

A System.Threading.Tasks.Task that completes when the effect begins.

Task

WhenCompleted

[get, ]

A System.Threading.Tasks.Task that completes when the effect finishes.

DateTimeOffset?

DismissalTime

[get, ]

Gets the expected ending time of the effect.

SITimeSpan?

TimeRemaining

[get, ]

The amount of time remaining until the effect finishes.