表示一個文字聊天指令。可以用來在父物件為 TextChatService 時創建自定義的文字聊天指令。
自定義指令最多可以有兩個別名,當用戶的訊息與以下任何一個值匹配時,會觸發事件:
PrimaryAlias 或 SecondaryAlias。有關自定義指令的範例,請參見 自定義文字聊天指令。
要了解更多有關使用 TextChatService 的信息,請參見 體驗內文字聊天。
概要
屬性
確定 TextChatCommand 是否啟用。
用於觸發 TextChatCommand 的主要別名。
用於觸發 TextChatCommand 的次要別名。
活動
開發人員可以綁定以執行命令的事件。
屬性
AutocompleteVisible
PrimaryAlias
用於觸發 TextChatCommand 的主要別名。
如果用戶使用 TextChannel:SendAsync() 發送的消息與 PrimaryAlias 匹配,則該消息不會發送,反而會觸發 TextChatCommand.Triggered。
方法
活動
Triggered
開發人員可以綁定以執行命令的事件。
當用戶通過 TextChannel:SendAsync() 向服務器發送消息時,TextChatCommand 會攔截此消息,如果消息的內容與以下任一項匹配,則不會傳播給其他用戶:
PrimaryAlias 或 SecondaryAlias。
例如,對於一個 TextChatCommand 其 TextChatCommand.PrimaryAlias 為 "mute",如果用戶發送 "/mute SomeUserName",則靜音的相關 TextChatCommand 將觸發它的 TextChatCommand.Triggered。消息 "/mute SomeUserName" 不會傳播給其他用戶。
參數
一個參考,指向通過 TextChannel:SendAsync() 觸發命令的 TextSource。
用於觸發命令的完整、未過濾的文本,可以用來解析命令消息中的參數。