EffectResponse

A response to an EffectRequest block.

Kind: Class

Namespace: CrowdControl.Common

Inheritance: ResponseBlock → IEquatable\<CrowdControlBlock\>

Public Constructors

EffectResponse(Guid request, EffectStatus status, string message, Enum messageID, ErrorSource? errorSource, bool? abnormal = null)

Creates a new instance of the CrowdControl.Common.EffectResponse class.

EffectResponse(Guid request, EffectStatus status, SITimeSpan? timeRemaining, string message, Enum messageID, ErrorSource? errorSource, bool? abnormal = null)

Creates a new instance of the CrowdControl.Common.EffectResponse class.

Public Member Functions

virtual override

string

ToString()

Public Attributes

SITimeSpan

TimeRemaining

The due time of the effect, if applicable.

Dictionary

Metadata

Game metadata attached to the response.

string[]

Modified

If set, indicates that the named fields were incorrect and have been modified by an automated sanitization process.

Properties

bool

Success

[get, ]

true if the effect was processed successfully; otherwise, false.

EffectStatus

Status

[get, ]

The status of the effect.

DateTimeOffset

DueTime

[get, ]

The due time of the effect, if applicable.