Component:TwitchChatDialog: Difference between revisions

Latest revision as of 18:46, 30 April 2025

Component image

**Twitch Chat Dialog** component as seen in the Scene Inspector

Twitch chat dialogue is a component used to control and manage a live stream of chat messages sent by users at Twitch from a specific channel on Twitch.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`_canvas`	Canvas	The canvas this component generated for a visual twitch chat feed.
`_panel`	LegacyPanel	The panel this component generated for a visual twitch chat feed.
`MaxMessages`	Int	The maximum amount of messages to keep in the message feed before deleting old ones.
`Interface`	direct RelayRef`1<TwitchInterface>	The twitch interface that is providing and receiving events to allow this component to function.
`_channelName`	TextField	The text field that holds the name of the channel this component is displaying chat messages for.
`_viewerCount`	Text	The text object displaying the amount of users watching `_channelName`
`_messagesRoot`	Slot	the slot to put UIX text components under which are messages sent into `_channelName`'s chat.
`_messagesScrollRect`	ScrollRect	The scroll rectangle that is controlled to make sure it stays scrolled to the bottom as chat messages appear.
`_highlightPanel`	Image	The image used for when the panel is highlighted.
`_highlightText`	Text	The text used for when the panel is highlighted.
`_spriteSheet`	DynamicSpriteFont	The dynamically changing sprite font for text characters like custom twitch emojis.
`_fontCollection`	FontCollection	A list of fonts used by chat messages from twitch.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
ChannelEditingStarted:Action`1<TextEditor>	Action`1<TextEditor>	✓	Handles when the user starts editing the target channel name.
ChannelEditingFinished:Action`1<TextEditor>	Action`1<TextEditor>	✓	Handles when the user finishes editing the target channel name.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

Used in the default Twitch chat item in Resonite Essentials.

@@ Line 3: / Line 3: @@
 |Name=Twitch Chat Dialog
 }}
-{{stub}}
+Twitch chat dialogue is a component used to control and manage a live stream of chat messages sent by users at Twitch from a specific channel on Twitch.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|_canvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv0=true|
+|_canvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv0=true| The canvas this component generated for a visual twitch chat feed.
-|_panel|'''[[Component:LegacyPanel|LegacyPanel]]'''|TypeAdv1=true|
+|_panel|'''[[Component:LegacyPanel|LegacyPanel]]'''|TypeAdv1=true| The panel this component generated for a visual twitch chat feed.
-|MaxMessages|Int|
+|MaxMessages|Int| The maximum amount of messages to keep in the message feed before deleting old ones.
-|Interface|{{RootFieldType|RelayRef`1|[[Component:TwitchInterface|TwitchInterface]]}}|TypeAdv3=true|
+|Interface|{{RootFieldType|RelayRef`1|[[Component:TwitchInterface|TwitchInterface]]}}|TypeAdv3=true| The twitch interface that is providing and receiving events to allow this component to function.
-|_channelName|'''[[Component:TextField|TextField]]'''|TypeAdv4=true|
+|_channelName|'''[[Component:TextField|TextField]]'''|TypeAdv4=true| The text field that holds the name of the channel this component is displaying chat messages for.
-|_viewerCount|'''[[Component:Text|Text]]'''|TypeAdv5=true|
+|_viewerCount|'''[[Component:Text|Text]]'''|TypeAdv5=true| The text object displaying the amount of users watching <code>_channelName</code>
-|_messagesRoot|Slot|
+|_messagesRoot|Slot| the slot to put UIX text components under which are messages sent into <code>_channelName</code>'s chat.
-|_messagesScrollRect|'''[[Component:ScrollRect|ScrollRect]]'''|TypeAdv7=true|
+|_messagesScrollRect|'''[[Component:ScrollRect|ScrollRect]]'''|TypeAdv7=true| The scroll rectangle that is controlled to make sure it stays scrolled to the bottom as chat messages appear.
-|_highlightPanel|'''[[Component:Image|Image]]'''|TypeAdv8=true|
+|_highlightPanel|'''[[Component:Image|Image]]'''|TypeAdv8=true| The image used for when the panel is highlighted.
-|_highlightText|'''[[Component:Text|Text]]'''|TypeAdv9=true|
+|_highlightText|'''[[Component:Text|Text]]'''|TypeAdv9=true| The text used for when the panel is highlighted.
-|_spriteSheet|'''[[Component:DynamicSpriteFont|DynamicSpriteFont]]'''|TypeAdv10=true|
+|_spriteSheet|'''[[Component:DynamicSpriteFont|DynamicSpriteFont]]'''|TypeAdv10=true| The dynamically changing sprite font for text characters like custom twitch emojis.
-|_fontCollection|'''[[Component:FontCollection|FontCollection]]'''|TypeAdv11=true|
+|_fontCollection|'''[[Component:FontCollection|FontCollection]]'''|TypeAdv11=true| A list of fonts used by chat messages from twitch.
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|ChannelEditingStarted:[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;|true| Handles when the user starts editing the target channel name.
+|ChannelEditingFinished:[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;|[[Type:Action`1|Action`1]]&lt;[[Component:TextEditor|TextEditor]]&gt;|true| Handles when the user finishes editing the target channel name.
 }}
-== Behavior ==
+== Usage ==
+{{stub}}
 == Examples ==
+Used in the default Twitch chat item in Resonite Essentials.
 == See Also ==
@@ Line 29: / Line 37: @@
 [[Category:Components:Uncategorized{{#translation:}}|Twitch Chat Dialog]]
 [[Category:Components{{#translation:}}|Twitch Chat Dialog]]
-[[Category:ComponentStubs]]