EffectStatus ​
The state of an effect.
Kind: Enum
Namespace: ConnectorLib.JSON
Inheritance: IComparable → IConvertible → IFormattable → ISpanFormattable
Public Attributes
EffectStatus
Success
The effect executed successfully.
EffectStatus
Failure
The effect failed to trigger, but is still available for use. Viewer(s) will be refunded. You probably don't want this.
EffectStatus
Unavailable
Same as ConnectorLib.JSON.EffectStatus.Failure but the effect is no longer available for use for the remainder of the game. You probably don't want this.
EffectStatus
Retry
The effect cannot be triggered right now, try again in a few seconds. This is the "normal" failure response.
EffectStatus
Queue
INTERNAL USE ONLY. The effect has been queued for execution after the current one ends. Do not send this status unless explicitly instructed to by Warp World.
EffectStatus
Running
INTERNAL USE ONLY. The effect triggered successfully and is now active until it ends. Do not send this status unless explicitly instructed to by Warp World.
EffectStatus
Paused
The timed effect has been paused and is now waiting.
EffectStatus
Resumed
The timed effect has been resumed and is counting down again.
EffectStatus
Finished
The timed effect has finished.
EffectStatus
Wait
The effect cannot be triggered right now. Wait for the specified time period for a followup response. Does not reschedule the request.
EffectStatus
RemoteScheduled
The effect is being managed by a remote scheduler. Wait indefinitely.
EffectStatus
Visible
The effect should be shown in the menu.
EffectStatus
NotVisible
The effect should be hidden in the menu.
EffectStatus
Selectable
The effect should be selectable in the menu.
EffectStatus
NotSelectable
The effect should be unselectable in the menu.
EffectStatus
Reserved0
INTERNAL USE ONLY. Absolutely do not send this status.
EffectStatus
NotReady
The processor isn't ready to start or has shut down.
Enums
EffectStatus
[Success = 0, Failure = 1, Unavailable = 2, Retry = 3, Queue = 4, Running = 5, Paused = 6, Resumed = 7, Finished = 8, Wait = 9, RemoteScheduled = 10, Visible = 128, NotVisible = 129, Selectable = 130, NotSelectable = 131, Reserved0 = 160, NotReady = 255]The state of an effect.