An Event in VTI refers to an instance of a Twitch user triggering a Target in a VRChat World with the VTI World Kit installed. When a Twitch performs an action that matches the Binding Settings for one or more Targets, the VTI Companion App will process the action, then create and enqueue an Event with any pertinent data. Then, when the VTI World Kit queries for a queue update, all queued Events will be serialized into JSON and sent to the VRChat client.
Once processed by the VTI World Kit, this Event will be queued up for firing once it reaches the front of the queue and its Target Object becomes available.
Event Data
All Events are serialized as JSON upon transmission, and contain the following data:
| Property | Type | Usage |
|---|---|---|
| ID | Guid | Globally Unique Identifier for this Event. |
| TargetID | string | The Unique ID of the Target Object. |
| UserName | string | The Twitch User Name of the user who triggered this Event. |
| Message | string | The User Message, if applicable, that was sent with this Event. |
| TriggerCause | string | The reason/event type that caused this Event to be created. |
| TriggerAmount | int | What "value" is associated with this Event, i.e. how many bits cheered, subs gifted, tier subscribed, etc. |
| Canceled | bool | Marked true when the VTI Companion App user selects the Cancel button on this Event.
|
Cancellation of Events
Events can be canceled at any time before they are fired. However, they may still fire after the Cancel button is clicked if the VTI World Kit does not receive the cancellation update in time before firing. This is due to the long delay imposed by Remote String Loading (see: VTI Function Overview).
In a future update, Events will be auto-canceled if their triggering action (chat message, channel point redeem, etc) is deleted by moderator action.