EffectRequest ​
Request to start an effect.
Kind: Class
Namespace: ConnectorLib.JSON
Inheritance: SimpleJSONRequest
Public Constructors
Creates a new instance of the ConnectorLib.JSON.EffectRequest class.
Public Attributes
string
code
The ID of the effect to start.
string
message
A message to be displayed to the user, if applicable.
JToken
parameters
The parameters for the effect, if any.
uint?
quantity
The quantity of the effect, if applicable.
JArray
targets
The targets of the effect. This is an array of ConnectorLib.JSON.EffectRequest.Target objects.
long?
duration
The duration of the effect in milliseconds. This is the time the effect should last.
string
viewer
The display name of the viewer or viewers who triggered the effect.
JArray
viewers
The viewers who triggered the effect. This is an array of ConnectorLib.JSON.EffectRequest.Target objects.
long?
cost
The cost of the effect in coins.
Dictionary
arguments
Additional parameter data associated with the effect.
Guid?
requestID
The ID of the effect request.
IEffectSourceDetails
sourceDetails
The source details of the effect request. This provides additional information about the source of the effect.