API Referenceglobal
IEventsclass
Implement this on a `Component` to receive stream chat events. They're dispatched to the active scene on the main thread, so it's safe to touch GameObjects from these.
object→IEvents
Methods7
Showing 7 methods
public virtual void OnStreamGiftSubscribe(Sandbox.Streamer.GiftSubscribeMessage message)
A viewer gifted a subscription to a specific recipient.
| Parameter | Type | Description |
|---|---|---|
| message | GiftSubscribeMessage | — |
Returns:
void—public virtual void OnStreamGiftSubscriptions(Sandbox.Streamer.GiftSubscriptionsMessage message)
A viewer gifted a batch of subscriptions to the community (a mystery/community gift).
| Parameter | Type | Description |
|---|---|---|
| message | GiftSubscriptionsMessage | — |
Returns:
void—public virtual void OnStreamJoin(Sandbox.Streamer.Viewer viewer)
A viewer joined chat.
| Parameter | Type | Description |
|---|---|---|
| viewer | Viewer | — |
Returns:
void—public virtual void OnStreamLeave(Sandbox.Streamer.Viewer viewer)
A viewer left chat. Note that Twitch sends leaves unreliably, so don't count on this firing.
| Parameter | Type | Description |
|---|---|---|
| viewer | Viewer | — |
Returns:
void—public virtual void OnStreamMessage(Sandbox.Streamer.ChatMessage message)
A chat message was received. Cheers arrive here too - check `Sandbox.Streamer.ChatMessage.Bits`.
| Parameter | Type | Description |
|---|---|---|
| message | ChatMessage | — |
Returns:
void—public virtual void OnStreamRaid(Sandbox.Streamer.RaidMessage message)
Another channel raided yours, bringing their viewers with them.
| Parameter | Type | Description |
|---|---|---|
| message | RaidMessage | — |
Returns:
void—public virtual void OnStreamSubscribe(Sandbox.Streamer.SubscribeMessage message)
A viewer subscribed or resubscribed to the channel.
| Parameter | Type | Description |
|---|---|---|
| message | SubscribeMessage | — |
Returns:
void—No results match this filter.