代表向 TextService:FilterStringAsync() 呼叫的結果。用於依照過濾字串進行分配。
概要
方法
以正確過濾的方式返回指定的 Player.UserId 的文字。
以正確過濾的方式返回所有使用者的文字。
以年齡和其他細節為基礎,以正確過濾的方式返回文字,用於指定的 Player.UserId 。
屬性
方法
GetChatForUserAsync
此方法以適當過濾的方式返回指定的 Player.UserId 文字,使用適當的最少限制過濾,並強制兩個用戶的隱私設置,使用 Chat 隱私設置。這應該在玩家之間的聊天上使用,雖然也有一些其他情況需要文字過濾。
返回的字串只應顯示給目標使用者,因為它可能不適合所有使用者。
如果此方法發生錯誤,字串不應該 顯示給用戶 。錯誤案例包括:
- 兩位使用者無法聊天,例如如果 Chat:CanUserChatAsync() 將返回給指定的發送者和接收者 false。
- ID為toUserId的使用者未在當前伺服器上線。
在大多數情況下,此功能會立即返回,但如果目標使用者剛剛加入服務器,並且過濾資訊尚未載入,則會返回。
部分過時警告
從客戶端呼叫此功能已過時,將在未來停用以返回空字串的情況下被禁用。與聊天相關的文字過濾應該通過 TextChatService 和經驗來完成,不正確過濾玩家生成的聊天文字可能會受到管理。
參數
Player.UserId 使用者正在聊天。
返回
過濾的文字字串。
GetNonChatStringForBroadcastAsync
以正確過濾的方式返回所有使用者的文字。這應該在每個使用者都可以看到的非聊天文字的上下文中使用,例如對話框,讓使用者在標誌上寫一條訊息,即使作者已離開伺服器,所有使用者都可以看到。
返回
過濾的文字字串。
GetNonChatStringForUserAsync
以年齡和其他細節為基礎,以正確過濾的方式返回文字,用於指定的 Player.UserId 。這應該在特定使用者可以看到的非聊天文字的上下文中使用,例如寵物的名稱。
參數
Player.UserId 用戶想要查看/接收文本。
返回
過濾的文字字串。