TextChatCommand¶
Represents a text chat command.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
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.
Inheritance¶
Object → Instance → TextChatCommand
Properties¶
| Member | Signature | Summary |
|---|---|---|
AutocompleteVisible |
AutocompleteVisible: bool |
Determines whether the TextChatCommand is shown as a suggestion in the chat autocomplete menu. |
Enabled |
Enabled: bool |
Determines whether the TextChatCommand is enabled. |
PrimaryAlias |
PrimaryAlias: string |
A primary alias used to trigger the TextChatCommand. |
SecondaryAlias |
SecondaryAlias: string |
A secondary alias used to trigger the TextChatCommand. |
Events¶
| Member | Signature | Summary |
|---|---|---|
Triggered |
Triggered(originTextSource: TextSource, unfilteredText: string) |
An event that developers can bind to execute commands. |
Roblox reference: TextChatCommand
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.