Main API Entry Points
Check that the Twitch Integration Mod is enabled!!!
TwitchModInfo.TwitchIsPresent should be used before calling any of the API functions that may interface with the Twitch Integration mod. Most other methods will crash if called when the Twitch Integration mod is not present. Check the status of this bool to be sure that the Twitch Integration mod is present and enabled.
Most methods should be called after the Twitch Integration mod has run its initialization. This typically means running all of your event setup in a patch:
[HarmonyPatch(typeof(Db), "Initialize")]
[HarmonyAfter(TwitchModInfo.StaticID)]
public static class Db_Initialize_Patch {
The HarmonyAfter attribute takes the StaticID of the mod that you want to run after, and in this case is used to run after the Twitch Integration mod.
Complete examples can be found on GitHub.
Creating an Event
Create an EventGroup:
- EventGroup.GetOrCreateGroup(string)
- EventGroup.DefaultSingleEventGroup(string, int, string)
- This creates both an event and a group, returning both to be used.
Add an event to an EventGroup:
Modify an EventInfo:
- Set the display name of the event (if not already set): FriendlyName
- Specify how dangerous the event is: Danger
- Add code to the event: AddListener
- Add a condition for the event to appear in a vote: AddCondition
- NOTE: The condition may become false between it showing up in a vote and the code being run. Design your event's code to be resistant to any possible states. Do nothing and show a toast rather than crash.
- Examples of invalidated state:
- At least one dupe was alive before, but now none are, so an event needs to find a default target or do nothing.
- A rocket was in flight when the condition ran, but landed or self destructed.
- A building existed when the condition ran, but has since been deconstructed, melted, or otherwise damaged.
Add an EventGroup to the deck of possible events: