TextChatCommand

Whether this TextChatCommand appears as a suggestion in the chat autocomplete menu. Defaults to true.

When true, PrimaryAlias is offered in the autocomplete list. Set to false to hide it from suggestions; the command still works when typed in full via PrimaryAlias or SecondaryAlias.

Autocomplete itself is controlled by ChatInputBarConfiguration.AutocompleteEnabled.

Determines whether the TextChatCommand is enabled.

When disabled, messages that match the value of PrimaryAlias or SecondaryAlias are not sunk and is sent to other users.

Use this to disable default commands on a case-by-case basis.

A primary alias used to trigger the TextChatCommand.

If a user sends a message with TextChannel:SendAsync() that matches the PrimaryAlias, the message is not sent and instead TextChatCommand.Triggered is fired.

A secondary alias used to trigger the TextChatCommand, in addition to its PrimaryAlias.

If a user sends a message with TextChannel:SendAsync() that matches the SecondaryAlias, the message is not sent and instead TextChatCommand.Triggered is fired, exactly as it is for the PrimaryAlias. Matching is case-insensitive, and the alias must be followed by the end of the message or a space, so a SecondaryAlias of "/e" matches "/e" and "/e dance" but not "/emote".

Defaults to an empty string, in which case only the PrimaryAlias triggers the command.

An event that developers can bind to execute commands.

When a user sends a message to the server via TextChannel:SendAsync(), the message is intercepted by the TextChatCommand and not replicated to other users if the content of the message matches the PrimaryAlias or SecondaryAlias.

For example, for a TextChatCommand with TextChatCommand.PrimaryAlias as "mute", if a user sends "/mute SomeUserName", then the relevant TextChatCommand for mute will fire its TextChatCommand.Triggered. The message "/mute SomeUserName" is not replicated to other users.