Skip to main content
Corvus Connection

On Cheer

Twitch
Trigger
entry.onCheerFires when a viewer cheers with bits. Binds the cheerer (or Anonymous), the amount, and the message.Triggers on a bits cheer.
MonetizationAlertsEngagement

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
displayName
Data
System.String
multiplexed
bits
Data
System.Int32
multiplexed
message
Data
System.String
multiplexed
isAnonymous
Data
System.Boolean
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    displayName
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    bits
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    message
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    isAnonymous
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed

Bindings

Name
Type
Description
displayName
System.String
The cheerer's display name, or "Anonymous" for an anonymous cheer.
bits
System.Int32
The number of bits cheered.
message
System.String
The chat message accompanying the cheer.
isAnonymous
System.Boolean
True when the cheer was anonymous.
  • Name
    displayName
    Type
    System.String
    Description
    The cheerer's display name, or "Anonymous" for an anonymous cheer.
  • Name
    bits
    Type
    System.Int32
    Description
    The number of bits cheered.
  • Name
    message
    Type
    System.String
    Description
    The chat message accompanying the cheer.
  • Name
    isAnonymous
    Type
    System.Boolean
    Description
    True when the cheer was anonymous.

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#

[OnCheer] Handle(ctx, CheerContext e)

Used in