Guide
Test Guide
Support
You can follow the general setup guide at https://crowdcontrol.live/setup for extra help with the Twitch Extension, the Crowd Control Desktop Client and other options.
If you have any questions or need help with this setup, please head over to our discord, forum or email us for additional support!
| Parameter | Type | Remarks |
| request | EffectRequest | The request object associated with the checks/actions being performed. |
| condition | Func<bool> | Returns true if the effect is ready to start. |
| action | Func<bool> | Called once startCondition returns true. Returns true if the effect has started successfully. Start-up logic goes here. |
| followUp | Action | Called once action returns true. Follow-up logic goes here. |
| retryDelay | Func<SITimeSpan> | Returns a duration to wait before calling condition after a failed condition/action. |
| retryOnFail | bool | True if the effect should be automatically retried in the case of failures. This should almost always be true. |
| mutex | string
-or- IEnumerable<string> |
Any mutex keywords. Effects that define any mutex keywords will never run simultaneously. This is useful for handling effects that would overwrite each other or otherwise clash. |
| holdMutex | SITimeSpan? | The duration to hold any mutexes after the effect finishes. Useful for effects that require a short cooldown to be used safely. |
