Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TextChatCommand

Represents a text chat command.

Memory categoryInstances

Member index 5

HistoryMember
596AutocompleteVisible: bool
553Enabled: bool
514PrimaryAlias: string
514SecondaryAlias: string
514Triggered(originTextSource: TextSource, unfilteredText: string)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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 types "/{PrimaryAlias}" or "/{SecondaryAlias}" into the chat.

To learn more about using TextChatService, see In-Experience Text Chat.

History 8

Members 5

AutocompleteVisible

TypeDefault
booltrue
Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 1

Enabled

TypeDefault
booltrue

Determines whether the TextChatCommand is enabled.

When disabled, messages that match "/{PrimaryAlias}" or "/{SecondaryAlias}" is not sunk and is sent to other users.

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

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 2

PrimaryAlias

TypeDefault
string

A primary alias used to trigger the TextChatCommand.

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

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 1

SecondaryAlias

TypeDefault
string

A secondary alias used to trigger the TextChatCommand.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 1

Triggered

Parameters (2)
originTextSourceTextSource
unfilteredTextstring

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 "/{TextChatCommand.PrimaryAlias}" or "/{TextChatCommand.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.

Thread safetyUnsafe

History 1

Settings