Types
Structs and enums used by the plugin.
FCrowdControlEffectInfo
Metadata for an instant effect.
| Field | Description |
|---|---|
id | Unique effect ID (lowercase, no spaces). |
displayName | Name shown to viewers. |
description | Description shown to viewers. |
price | Price in coins (default 1). |
category | Array of menu category names. |
FCrowdControlTimedEffectInfo
Extends FCrowdControlEffectInfo for timed effects.
| Field | Description |
|---|---|
duration | Effect duration in seconds. |
FCrowdControlParameterEffectInfo
Extends FCrowdControlEffectInfo for effects with viewer-selectable parameters.
| Field | Description |
|---|---|
RequiresQuantity | Whether viewers pick a quantity. |
quantity | Allowed quantity range. |
parameters | Array of FCrowdControlParameter. |
FCrowdControlParameter
| Field | Description |
|---|---|
_id | Parameter ID. |
name | Display name. |
type | ECrowdControlParamType: OPTIONS, HexColor, or MinMax. |
_options | For OPTIONS: array of FCrowdControlParamOption (id + DisplayName). |
min / max | For MinMax: allowed numeric range. |
Helpers: MakeOptionParameter and MakeMinMaxParameter in UCrowdControlFunctionLibrary.
ECrowdControlEffectResult
Returned from UCrowdControlEffectComponent::OnEffectTriggered.
| Value | Meaning |
|---|---|
Success | Effect applied; success reported automatically. |
FailTemporary | Can't run right now; reported as failTemporary (refund, may retry). |
FailPermanent | Can never run; reported as failPermanent. |
Pending | Component responds later via CompleteSuccess/CompleteFail*. |
ECrowdControlConnectionState
Reported by OnConnectionStateChanged.
| Value | Meaning |
|---|---|
Connecting | Connection in progress. |
Disconnected | Not connected. |
WaitingForLogin | Connected, waiting for the user to log in / authorize. |
Connected | Authenticated and ready for effects. |
ECrowdControlEffectReport
Used with ReportEffectStatus.
| Value | Meaning |
|---|---|
MenuVisible / MenuHidden | Show or hide the effect in the menu. |
MenuAvailable / MenuUnavailable | Allow or block purchasing. Independent from visibility. |