ProtoFlux:Twitch Chat Message Event: Difference between revisions

From Resonite Wiki
Added flux node and rudimentary explanation of outputs.
 
m Added category to Twitch
 
Line 105: Line 105:
If the chat message was sent with a custom reward redeem, shows the ID of the custom reward.
If the chat message was sent with a custom reward redeem, shows the ID of the custom reward.
This will only output the custom reward ID if the redeem has the "Require Viewer to Enter Text" option enabled.
This will only output the custom reward ID if the redeem has the "Require Viewer to Enter Text" option enabled.
[[Category:ProtoFlux:Network:Twitch]]

Latest revision as of 00:21, 1 April 2024

Twitch Chat Message Event
OnMessage
Message
UserId
DisplayName
Color
IsHighlighted
IsSubscriber
IsModerator
IsBroadcaster
IsTurbo
IsVIP
CheerBadge
CheerAmount
Bits
BitsDollars
SubscribedMonthCount
CustomRewardId
Interface
null
Twitch

This node provides Twitch chat message information from a TwitchInterface.

Note that all outputs are generated on a new Twitch chat message, and will not display any information when connected to a display node.

Outputs

OnMessage (Call)

Fires on receiving a new Twitch chat message.

Message (String)

Outputs the contents of the message as a text string.

UserId (String)

Outputs the Twitch Channel ID of the message sender.

DisplayName (String)

Outputs the Twitch username of the message sender.

Color (Color)

Outputs the Twitch chat color of the message sender.

IsHighlighted (Bool)

Shows if the chat message is highlighted.

IsSubscriber (Bool)

Shows if the chat message sender is subscribed to the Twitch channel.

IsModerator (Bool)

Shows if the chat message sender is a moderator of the Twitch channel.

IsBroadcaster (Bool)

Shows if the chat message sender is from the Twitch channel, or broadcaster.

IsTurbo (Bool)

Shows if the chat message sender is subscribed to Twitch Turbo.

IsVIP (Bool)

Shows if the chat message sender is a VIP in the Twitch channel.

CheerBadge (BadgeColor)

Shows the current cheer chat badge of the chat message sender.

CheerAmount (Int)

Shows the cheer amount if the chat message includes any bits.

Bits (Int)

Shows the bit amount if the chat message includes any.

BitsDollars (Double)

Shows the bit amount in USD (United States Dollars), as a double value.

SubscribedMonthCount (Int)

Shows the amount of months the chat message sender is subscribed to the channel.

CustomRewardId (String)

If the chat message was sent with a custom reward redeem, shows the ID of the custom reward. This will only output the custom reward ID if the redeem has the "Require Viewer to Enter Text" option enabled.