Skip to content

EffectReport ​

An update on the general state of an effect.

Kind: Class

Namespace: CrowdControl.Common

Inheritance: CrowdControlBlock → IEquatable\<CrowdControlBlock\>

Public Constructors

EffectReport(string effect, EffectStatus status, string message = null, Enum messageID = null)

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

EffectReport(IEnumerable ids, IdentifierType idType, EffectStatus status, string message = null)

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

Public Member Functions

virtual override

string

ToString()

Public Attributes

string[]

IDs

The ID of the effect to which this report pertains.

string

Message

The message from the client (if any).

string

MessageID

The ID of a standardized message.

Properties

IdentifierType

IDType

[get, ]

The type of the ID specified.

EffectReportType

EffectType

[get, ]

The type of the effect.

EffectStatus

Status

[get, ]

The status of the effect.