Skip to main content
Corvus Connection

On Hype Train Begin

Twitch
Trigger
entry.onHypeTrainBeginFires when a hype train begins. Binds the level, progress, goal, running total, train type, top contributor, all-time high, and whether it is a shared (co-op) train.Triggers when a hype train starts.
MonetizationEngagementAlerts

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
level
Data
System.Int32
multiplexed
progress
Data
System.Int32
multiplexed
goal
Data
System.Int32
multiplexed
total
Data
System.Int32
multiplexed
type
Data
System.String
multiplexed
topContributor
Data
System.String
multiplexed
allTimeHighLevel
Data
System.Int32
multiplexed
allTimeHighTotal
Data
System.Int32
multiplexed
isSharedTrain
Data
System.Boolean
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    level
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    progress
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    goal
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    total
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    type
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    topContributor
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    allTimeHighLevel
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    allTimeHighTotal
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    isSharedTrain
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed

Bindings

Name
Type
Description
level
System.Int32
The current Hype Train level.
progress
System.Int32
Progress toward the current level's goal.
goal
System.Int32
The points needed to reach the next level.
total
System.Int32
Total points contributed so far.
type
System.String
The Hype Train type (e.g. regular or golden kappa).
topContributor
System.String
The top contributor's display name.
allTimeHighLevel
System.Int32
The channel's all-time-high Hype Train level.
allTimeHighTotal
System.Int32
The channel's all-time-high Hype Train total.
isSharedTrain
System.Boolean
True when this is a shared Hype Train.
  • Name
    level
    Type
    System.Int32
    Description
    The current Hype Train level.
  • Name
    progress
    Type
    System.Int32
    Description
    Progress toward the current level's goal.
  • Name
    goal
    Type
    System.Int32
    Description
    The points needed to reach the next level.
  • Name
    total
    Type
    System.Int32
    Description
    Total points contributed so far.
  • Name
    type
    Type
    System.String
    Description
    The Hype Train type (e.g. regular or golden kappa).
  • Name
    topContributor
    Type
    System.String
    Description
    The top contributor's display name.
  • Name
    allTimeHighLevel
    Type
    System.Int32
    Description
    The channel's all-time-high Hype Train level.
  • Name
    allTimeHighTotal
    Type
    System.Int32
    Description
    The channel's all-time-high Hype Train total.
  • Name
    isSharedTrain
    Type
    System.Boolean
    Description
    True when this is a shared Hype Train.

Parameters

Name
Type
Required
Default
Choices
cooldownSeconds
System.Int32
no
0
None
perUserCooldownSeconds
System.Int32
no
0
None
debounceMs
System.Int32
no
0
None
dedupeKey
System.String
no
""
None
maxConcurrency
System.Int32
no
0
None
  • Name
    cooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    perUserCooldownSeconds
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    debounceMs
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None
  • Name
    dedupeKey
    Type
    System.String
    Required
    no
    Default
    ""
    Choices
    None
  • Name
    maxConcurrency
    Type
    System.Int32
    Required
    no
    Default
    0
    Choices
    None

Lowers to C#

[OnHypeTrainBegin] Handle(ctx, HypeTrainContext e)