TextChatCommand
Represents a text chat command. Can be used to create custom text chat commands when parented to TextChatService.
Custom commands can have up to two aliases, and the Triggered event fires when a user's message matches the value of either the PrimaryAlias or SecondaryAlias. For an example of custom commands, see Custom text chat commands.
To learn more about using TextChatService, see In-experience text chat.
Summary
Properties
Determines whether the TextChatCommand is enabled.
A primary alias used to trigger the TextChatCommand.
A secondary alias used to trigger the TextChatCommand.
Events
An event that developers can bind to execute commands.
Properties
AutocompleteVisible
Enabled
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.
PrimaryAlias
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.
Methods
Events
Triggered
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.
Parameters
A reference to the TextSource responsible for triggering the command via TextChannel:SendAsync().
The full, unfiltered text used to trigger the command that can be used to dissect parameters from the command message.