Skip to main content
Corvus Connection

On Chat Command

Entry
Trigger
entry.onChatCommandFires when a chat message is a command (prefix + word). Binds the command, its arguments, and the sender.
ChatEngagement

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
command
Data
System.String
multiplexed
args
Data
System.String
multiplexed
argCount
Data
System.Int32
multiplexed
user
Data
System.String
multiplexed
message
Data
System.String
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    command
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    args
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    argCount
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    user
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    message
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed

Bindings

Name
Type
Description
command
System.String
The command name, without its prefix.
args
System.String
The raw argument text after the command.
argCount
System.Int32
How many whitespace-separated arguments were supplied.
user
System.String
The chatter's display name.
message
System.String
The full chat message, including the command.
  • Name
    command
    Type
    System.String
    Description
    The command name, without its prefix.
  • Name
    args
    Type
    System.String
    Description
    The raw argument text after the command.
  • Name
    argCount
    Type
    System.Int32
    Description
    How many whitespace-separated arguments were supplied.
  • Name
    user
    Type
    System.String
    Description
    The chatter's display name.
  • Name
    message
    Type
    System.String
    Description
    The full chat message, including the command.

Parameters

Name
Type
Required
Default
Choices
command
System.String
yes
""
None
prefix
System.String
no
"!"
None
minRole
System.String
no
"everyone"
Everyone, Subscriber+, VIP+, Moderator+, Broadcaster
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
    command
    Type
    System.String
    Required
    yes
    Default
    ""
    Choices
    None
  • Name
    prefix
    Type
    System.String
    Required
    no
    Default
    "!"
    Choices
    None
  • Name
    minRole
    Type
    System.String
    Required
    no
    Default
    "everyone"
    Choices
    Everyone, Subscriber+, VIP+, Moderator+, Broadcaster
  • 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

Used in