Menu
Lumberyard
Legacy Reference

Twitch Nodes

Flow Graph is deprecated and will be removed in a future version of Lumberyard. Learn about Script Canvas, Lumberyard's new visual scripting environment.

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn about the latest features, see the Amazon Lumberyard User Guide.

You can use these flow graph nodes to configure Twitch-related settings.

You the attached entity dynamically by using the Choose Entity input port that is included on a number of flow graph nodes.

Twitch ChatPlay General Nodes

You can use the following flow graph nodes to configure general Twitch ChatPlay-related settings.

Twitch:Chatplay:Available node

Inputs

Port Type Description
Activate

Void

Checks the availability of Twitch ChatPlay.

Outputs

Port Type Description
Available

Void

Indicates that Twitch ChatPlay is available

Unavailable

Void

Indicates that Twitch ChatPlay is not available

Twitch:Chatplay:Channel node

Inputs

Port Type Description
Channel

String

Twitch channel name

Connect

Void

Initiates connection; idempotent if called while already connected or connecting. Resets the Error output state

Disconnect

Void

Initiates disconnection; idempotent if called while already disconnected or disconnecting

Outputs

Port Type Description
Connected

Boolean

Current state of the connection to the channel

Connecting

Boolean

Indicates whether the node is currently attempting to connect

Error

Boolean

Indicates an error has occurred

Twitch:Chatplay:DisconnectAll node

Inputs

Port Type Description
DisconnectAll

Void

Disconnects all Twitch ChatPlay channels

Twitch:Chatplay:Keyword node

Inputs

Port Type Description
Channel

String

Twitch channel name

Keyword

String

Keyword to match

Start

Void

Starts scanning for keywords; idempotent if called while already started

Stop

Void

Stops scanning for a keywords; idempotent if called while already stopped

Reset

Integer

Controls the initial signal count; changes to Reset are applied immediately to the current signal count

Outputs

Port Type Description
Signal

Integer

Event that fires when the keyword is received on the specified channel; the value is incremented by +1 each time a keyword is received

Active

Boolean

Indicates whether the node is currently active; true if signals can occur (set as soon as Start is triggered); otherwise, false (set as soon as Stop is triggered)

Error

Boolean

Indicates that an error has occurred

Twitch:Chatplay:RegisterCredentials node

Inputs

Port Type Description
Activate

Void

Registers the user name and OAuth token credential pair

Username

String

Twitch user name

OAuth_Token

String

OAuth tokens are generated with the Twitch Chat OAuth Password Generator.

Outputs

Port Type Description
Out

Void

Signaled when done registering credentials

Error

Boolean

Indicates that an error has occurred

Twitch:Chatplay:UnregisterCredentials node

Inputs

Port Type Description
Activate

Void

Unregisters the user name and associated OAuth token

Username

String

Twitch user name

Outputs

Port Type Description
Out Void

Indicates when the unregistering of the credential has finished

Error

Boolean

Indicates that an error has occurred

Twitch:Chatplay:UnregisterAllCredentials node

Inputs

Port Type Description
Activate

Void

Unregisters all credentials at once

Outputs

Port Type Description
Out

Void

Indicates when the unregistering of all credential has finished

Error

Boolean

Indicates when an error occurs

Twitch:Chatplay:Whisper node

Inputs

Port Type Description
Activate

Void

Sends the message as a whisper on behalf of the sender to the recipient

Sender

String

Twitch user name of sender; must have credentials registered to successfully send a whisper (see Twitch:ChatPlay:RegisterCredentials node)

Recipient

String

Twitch user name of recipient

Message

String

Message to whisper to recipient

Outputs

Port Type Description
Success

Void

Signaled if the whisper is sent successfully.

Error

Boolean

Signaled as true if an error occurred.

Twitch ChatPlay Voting Nodes

Twitch ChatPlay voting functionality make it easier to set up polls, surveys, and votes. The following figure shows an example of how various flow graph voting nodes work together.

Twitch:Chatplay:Voting:HighScores node

Inputs

Port Type Description
Activate

Void

Queries the high scores

VoteName

String

The name of the vote

Reset

Void

Resets all counts to zero

Outputs

Port Type Description
Done

Void

Indicates when the operation is complete

Error

Void

Indicates that an error occurred

Count1 - Count4

Integer

Indicates the vote count for option 1, 2, 3, and 4

Name1 - Name4

String

The names for options 1, 2, 3, and 4

Twitch:Chatplay:Voting:Option node

Inputs

Port Type Description
VoteName

String

The name of the vote

OptionName

String

The name of the voting option

Enable

Void

Enables the option and that it can be voted on

Disable

Void

Disables the ability to vote on the option

Remove

Void

Deletes the option

Outputs

Port Type Description
Done

Void

Indicates when the operation is complete

Error

Void

Indicates that an error occurred

Twitch:Chatplay:Voting:Score node

Inputs

Port Type Description
Activate

Void

Queries the score for an option.

VoteName

String

The name of the vote

OptionName

String

The name of the voting option

Reset

Void

Resets the count to zero

Outputs

Port Type Description
Done

Void

Indicates when the operation is complete

Error

Void

Indicates that an error occurred

Count

Integer

Indicates the current vote count

Enabled

Boolean

Indicates the current option state

Twitch:Chatplay:Voting:Vote node

Inputs

Port Type Description
VoteName

String

The name of the vote

Channel

String

The Twitch ChatPlay channel used to connect the vote to

Enable

Void

Enables the vote and that it can be voted on

Disable

Void

Disables the ability to vote on the vote

Outputs

Port Type Description
Done

Void

Indicates when the operation is complete

Error

Void

Indicates that an error occurred

Twitch JoinIn Nodes

Twitch JoinIn nodes are used to create a link that includes all the multiplayer session information necessary for other players to connect to the session.

Inputs

Port Type Description
Activate

Void

Generates a game: protocol link that allows players to join the current game

Command

String

The commands to pass when a game launches

Outputs

Port Type Description
Out

String

Signaled with the generated link.

Error Boolean

Indicates that an error occurred

TwitchAPI Nodes

TwitchAPI nodes are used to make calls to Twitch's REST API from within Lumberyard.

Twitch:API:GET node

Inputs

Port Type Description
Channel String

Twitch channel name

API_Key

String enum

API call type and key; call types based on channel ID: channel, chat, follows, streams, subscriptions, and user

Get Any

Caching has not been implemented, triggering the Get port will always start a new API call

Outputs

Port Type Description
Output

Any

Returned value for the given API call type and key; triggered whenever an API call is completed

Error

Integer

Indicates whether an error has occurred; it may be triggered with one of the following values:

1: the value for the requested API key was null

2: the value for the requested API key was of an unexpected type

3: the HTTP request failed